環境変数をドキュメント化しておきませんか？という提案

2025/01/16 25 users 環境変数 ドキュメント化 提案 リポジトリ アプリケーション毎

みなさんちゃんとドキュメント書いていますか？ 私は日頃からドキュメントの作成を心がけているのですが、以前ふと思いついて作成したドキュメントが結構良かったのでそれを共有しに来ました。 環境変数をドキュメント化する タイトルの通りですが、プロジェクト(≒リポジトリ,アプリケーション毎)で利用する環境変数の一... 続きを読む

perplexityのスペース機能がソフトウェアの調べものに便利 - mrwk update

2025/01/02 243 users GitHub Perplexity プロンプト ソフトウェア

TL;DR perplexity のスペースは情報源をURLとファイルで登録できる →質問するとそこを優先的に検索 →githubや公式サイト、ドキュメントを登録する →ソフトウェアの調べものがはかどる! 注意点: 日本語で質問すると日本語で検索しようとして失敗する。プロンプトで「(質問本文) 英語で検索して日本語でまとめて」って書く... 続きを読む

新卒2年目で退職するエンジニアのAさんへ - キムチのきもち

2025/01/03 40 users きもち キムチ エンジニア PJT Aさん

5月から10月に入っていた現場に、新卒2年目のジュニアエンジニアAさんがいました。 しかし、PJTの終わりごろ、Aさんがその現場を最後に退職することを知りました。 彼にはたくさん質問に答えてもらいましたし、助けてもらった恩がありました。 だから、私はAさんに餞別として1本のドキュメントを作成しました。 この記事... 続きを読む

AI自作レビュー、「USBケーブルの種類を見分けるAIモデル」をトレーニングしてAIカメラを作ってみた【Raspberry Pi AI Camera】

2025/01/02 5 users Raspberry Pi USBケーブル AIカメラ 種類

2024年9月に登場した「Raspberry Pi AI Camera」は、カメラセンサー内にAI処理用のプロセッサを内蔵しており、カメラそのものにAIモデルを読み込ませてAIカメラとして使うことができます。ドキュメントも充実しており、比較的簡単にAIモデルを自作できそうだったので、実際に「USBケーブルの種類を見分けるAIモデル」を... 続きを読む

Amazon Bedrockで「ユーザがアップロードしたドキュメントから回答を得る」方法のまとめ - Qiita

2024/12/24 15 users ユーザ Amazon Bedrock 回答 ナレッジベース

はじめに 生成AIの文脈において、RAG（Retrieval-Augmented Generation）と呼ばれる技術は、生成AIのモデルがプロンプトを解釈し、ナレッジベースから関連情報を検索し、その情報を基にコンテンツ(回答)を生成するために活用されるものです。 RAGを活用すれば、生成AIのモデルが学習していない最新かつインターネットに... 続きを読む

Aurora DSQLの制約を知ってより理解を深める | DevelopersIO

2024/12/19 17 users DevelopersIO Aurora 制約 テクノロジー

「制約を知れば知るほど、もっとそのテクノロジーへの愛が深まる…」 以前こんなツイートしたところ、いくらか反応がありました。 re:Invent 2024におけるAurora DSQLの発表はかなりのインパクトがあったのですが、ドキュメントを見れば見るほど、これは従来のAurora（PostgreSQL）とはかなり違うなぁという印象を持つ人... 続きを読む

クレジットカードの不正検知システムを3日で設計し、3週間で本番リリースした話 - LLMで加速するソフトウェア開発 - LayerX エンジニアブログ

2024/12/18 187 users LLM活用 要件 Design Doc LLM 検知システム

はじめに 背景：クレジットカード不正検知システムとは 3日でDesign Doc 2本、ADR 5本を執筆 3週間で開発し、本番環境にリリース LLM活用による効率化のポイント 目的・要件の整理 要件を満たす技術的オプションの洗い出し・技術調査 PoC実装 ドキュメントの執筆・技術選定 本実装 学び おわりに はじめに 新規プロダク... 続きを読む

LLMを悩ませる"Excel文書"をうまく扱う方法

2024/12/08 97 users LLM Rag シロクマ チャットボット Excel文書

はじめに 株式会社ファースト・オートメーションCTOの田中(しろくま)です！ 弊社では製造業向けのRAGを使ったチャットボットの開発を行っていますが、 RAGで読み取りづらいなと感じているドキュメントが"Excel文書"です。 LLMを悩ませる"Excel文書"とは ここで"Excel文書"と呼んでいるドキュメントは、 「構造化されたテ... 続きを読む

サクッと伝わるドキュメントを目指すためにエンジニアが意識していること

2024/12/06 161 users エンジニア ディスカッション 中井 Design Doc 機会

この記事は？ 株式会社ログラスでクラウドインフラエンジニアをしている中井 (@elmodev09) です。 エンジニアとして働ていると、技術選定の調査結果をまとめたり、Design Docを書く等、ドキュメントを書く機会が多いのではないでしょうか？ ドキュメントは、不必要なディスカッションを減らすための非常に強力なツールで... 続きを読む

マルチモーダルLLMで複雑な画像を攻略：AOAIでGPT-4oをFine-tuning - Insight Edge Tech Blog

2024/12/02 13 users マルチモーダルLLM LLM Fine-tuning 藤村

はじめに Insight EdgeのLLM Engineerの藤村です。 昨今、企業のDX推進に伴い、社内に蓄積された大量の画像データや文書の効率的な活用が求められています。弊社では、実務でLLMを活用する際、画像や表形式、複雑な図を含むドキュメントの理解が大きな課題となっています。この課題は多くの企業でも同様に直面していると... 続きを読む

【エンジニアのためのドキュメントライティング術】最低限知っておきたい、ドキュメントの重要性と書きはじめる前の準備

2024/11/30 56 users エンジニア 口頭 最低限 互い 必須

一定の規模の開発であればドキュメントは必須です。ドキュメントを使わない開発が存在するならば、すべての情報を口頭やチャットを使い、ソースコードレベルで記述する必要があります。一方で、効果的に記述されて運用されているドキュメントには、開発組織・チームをスケールさせる力があります。ドキュメントは互いの... 続きを読む

エンジニアが一生困らないドキュメント作成の基本（仲田 尚央） | 書籍 | ソシム

2024/11/24 338 users テクニカルライター ソシム 後回し 本書 スペシャリスト

「コードを書くのは好きだけどドキュメントは苦手」 「ドキュメントはつい後回しにしてしまう」 エンジニアの皆さん、そんな覚えはありませんか？ 本書は、日本語ドキュメントのスペシャリストであるテクニカルライターの著者が、エンジニアが「いつ」「何のドキュメントを」「どうやって」書けばよいのかを、イチから解... 続きを読む

Next.jsのsearchParamsはas stringせずに必ずバリデーションしてくれ。またはvalibotのちょいテクニック

2024/11/18 21 users Valibot undefined String テクニック

Next.jsのsearchParamsの型問題 Next.jsのsearchParamsの型は少々厄介です。searchParamsのドキュメントでは次のように型定義が記載されています。 export default async function Page({ searchParams, }: { searchParams: Promise<{ [key: string]: string | string[] | undefined }>; }) { const filters = (await se... 続きを読む

脆弱性診断＝アタックサーフェスマネジメント？　新興キーワードを深く学ぼう

2024/11/12 9 users ISOG-J ガイダンス アタック 脆弱性診断 最初

2024年11月、日本セキュリティオペレーション事業者協議会（ISOG-J）から、「ASM導入検討を進めるためのガイダンス（基礎編）」が公開されました。多くの企業から注目を集めている「アタックサーフェスマネジメント」を知る上で、最初に目を通すべき資料になり得る、コンパクトにまとまったドキュメントです。 アタック... 続きを読む

「Windowsメール」が2024年12月31日に機能停止する内容についてMicrosoftが詳細を公開

2024/11/12 23 users Microsoft Outlook 機能 内容 従来

Microsoftは新しいOutlook for Windowsを展開しており、従来のOutlookや他社製のメールクライアントアプリからの乗り換えを推奨しています。それに伴い、従来の「Windowsメール」は2024年12月31日にサポート終了することが以前から告知されていましたが、移行内容の詳細について、Microsoftがドキュメントを更新していま... 続きを読む

（改訂版）三項演算子は本当に読みにくいのか。TypeScript で分かった 後置 else if メソッド の効果

2024/11/11 26 users 構文 TypeScript コード メリット 改訂版

本記事はこちらの改訂版です。コードも改良しています。 三項演算子は本当に読みにくいのか コードをドキュメントのように読みやすくすることは非常に多くのメリットがあります。 そして、プログラミング言語自体にも読みやすくするためだけに存在する構文があります。 その１つが三項演算子です。 いやいや、三項演算子... 続きを読む

ドキュメントをMarkdownやJSONに変換してくれる「Docling」を試す

2024/11/05 188 users JSON Markdown

ここで知った。 試しに、神戸市が公開している観光に関する統計・調査資料のうち、「令和5年度 神戸市観光動向調査結果について」のPDFで一度試していたのだけども: （出典） 神戸市Webサイトの「観光に関する統計・調査」のページ 上記にある「令和5年度 神戸市観光動向調査結果について」のPDF 日本語でも、概ね問題な... 続きを読む

ドキュメントファイルの解析と変換に特化したオープンソースツール「docling」を試してみた | DevelopersIO

2024/11/05 53 users DevelopersIO 変換 解析 石川 文書ファイル

AWS事業本部コンサルティング部の石川です。最近、文書ファイルの解析と変換に特化した オープンソースツール「docling」 が注目を集めています。このツールは、最先端のAIモデルを活用して、ドキュメントの構造を理解し、様々な形式に変換することができます。今回、実際にdoclingを使用して日本語のドキュメントファイ... 続きを読む

SimRAGで専門分野にも強いRAGを作る

2024/11/05 8 users LLM 須藤英寿 RAGシステム 専門分野 チャット

導入 こんにちは、株式会社ナレッジセンスの須藤英寿です。普段はエンジニアとして、LLMを使用したチャットのサービスを提供しており、とりわけRAGシステムの改善は日々の課題になっています。 今回は、ドキュメントを活用して専門分野に強いRAGを構築できるSimRAGについて紹介します。 サマリー SimRAGは、専門分野に関... 続きを読む

「闇サイトで5万件のファイル公開された」──ニデック子会社、不正アクセスの被害状況を報告

2024/10/18 11 users ニデック 不正アクセス ファイル 被害状況 子会社

ニデック（旧：日本電産）の子会社であるニデックプレシジョン（東京都板橋区）は10月17日、ベトナム拠点（以下NPCV）が8月に受けた不正アクセス被害に関する調査結果を発表した。外部の悪質な犯罪集団にサーバ上のドキュメントなどを盗まれ、約5万件のファイルが闇サイトで公開されたという。 NPCVは8月5日、犯罪集団に... 続きを読む

LaravelはどのようにCSRF対策をしているのか？

2024/10/19 112 users Laravel BLADE CSRF対策 CSRF Form

誰しもLaravelのbladeでformを書くにあたって、@csrfという魔法の呪文を書いたことがあるかと思います。 「これを書いておけばCSRF対策はOK」 ドキュメントにも要約するとそういう旨が書いてあります。 この記事では@csrfについてLaravelの実装を実際に見てみることで、CSRFとその対策への理解を深めたいと思います。 ち... 続きを読む

「Google ドキュメント」に文書を複数の“タブ”に分割して作成する機能が追加／長い文書を分割、構造化して整理することで、より編集しやすく読みやすいドキュメントに

2024/10/09 21 users タブ 文書 分割 長い文書 複数

続きを読む

RAGを社内用語に強くするチャンク分割の手法「MoGG」

2024/10/01 9 users Rag 生成AI エンタープライズ向け 手法 プロダクト

株式会社ナレッジセンスは、生成AIやRAGを使ったプロダクトを、エンタープライズ向けに開発提供しているスタートアップです。本記事では、RAGの性能を高めるための「MoGG」という手法について、ざっくり理解します。 この記事は何 この記事は、社内用語が多く含まれるドキュメントでもRAGの性能を高くするための手法「Mo... 続きを読む

SBOMの本質を大阪大学 猪俣教授が語る――「うちのソフトは大丈夫なんです」とユーザーにどう証明する？

2024/09/30 5 users SBOM 本質 うち ユーザー 大阪大学

SBOMの本質を大阪大学 猪俣教授が語る――「うちのソフトは大丈夫なんです」とユーザーにどう証明する？：単なる「技術屋のドキュメント」ではない 大阪大学 情報セキュリティ本部 猪俣敦夫教授がベリサーブのプレスセミナーに「ソフトウェアの視える化により変革する社会システムとどう付き合うべきか」と題して講演した... 続きを読む

要件定義｜2分で読める機能要件で使うドキュメントを調べてみた - Qiita

2024/09/29 156 users 学習 感謝 エンジニア みなさま お疲れ様

はじめに エンジニアのみなさま、日々の学習本当にお疲れ様です！ また本記事まで足を運んでいただき本当に感謝です。 約2分程度で読めるので最後まで読んでもらえると幸いです。 要件定義関連の記事も投稿してます。時間あればぜひ読んでみてください！ 今回は「機能要件」に関する内容について投稿します。 機能要件と... 続きを読む