生成AIとの開発において面倒だけど助けになる、ドキュメント作成の話

AI CLIでの開発、いきなりプロンプトを打って「手戻り」や「誤送信」に悩まされていませんか？

本資料では、事前にMarkdown形式で要件やタスクを整理し、AIに参照させることで開発をスムーズに進める実践的なワークフローを紹介します。
「面倒だけど助けになる」ドキュメント作成を通じて、AIの精度を最大化し、副次的に仕様書を残すための具体的なTipsです。

## アジェンダ
1. 事前準備をしてAIでの開発を効率化しよう
2. 要件とタスクを最初に書き出す（PROJECT.md）
3. 仕様や外部情報をdocディレクトリにまとめる

Transcript

1. 2025/10/10 Jagu'e'r Gemini CLI Night! 成田愛奈 面倒だけど助けになる、ドキュメント作成の話
2. © 2022 KEEN Inc. 2 hg 界隈を分析する自社ツール「 KEEN 界隈DB」により つながり体験を向上する界隈起点のマーケティングを実現 独自アルゴリズムのデータ分析により !!! 界隈の中心人物 を発見！ 界隈 を特定！
3. © 2022 KEEN Inc. 3 KEENはコミュニティの力学を理解するアプローチで、 従来難しかった「語られる構造」の再現性を支援します KEENにしかできない「語られる構造」の理解と再現性 強み 02 ベストなクリエイターの 発見 構造的に界隈に アプローチする独自分析 強み 01 AIによる3D人分析 強み 03
4. © 2022 KEEN Inc. 4 成田愛奈 Narita Aina エンジニア /PdM • 2024年にKEEN株式会社に入社 「KEEN Manager」の開発、プロダクトマネジメントに従 事 • 前職は株式会社エニグモのサーバーサイドエンジニア として、通販サイトBUYMAの開発を行う。 Profile
5. © 2022 KEEN Inc. 5 事前準備をして AIでの開発を効率化しよう • AI に伝える要件を精査できずに実装の手戻りが 発生する • 変換や改行のエンターと送信のエンター間違えが ち CLIに直接プロンプトを入力すると … • 要件やタスクを言語化して確認できる • 大きめのタスクをドキュメントを通してAIに伝えるこ とができる 事前にドキュメントを用意して
6. © 2022 KEEN Inc. 6 要件とタスクを最初に書き出す • PROJECT.md など ◦ このファイルを @PROJECT.md でAIに参照させて開発を進め る • LLMを使ってもOK ◦ ドキュメントのレビューは人間がやる • 実装中に発生した変更は逐次アップデートする • プロンプトエンジニアリングのドキュメントは色々あるので参考にしよう ◦ OpenAI platform.openai.com/docs/guides/prompt-engineering ◦ オライリー LLMのプロンプトエンジニアリング プロジェクト用のドキュメントを用意する # PROJECT.md ## 概要 チームの業務データを可視化するダッシュボードを作る ## 要件 - 日次／週次の進捗データをグラフで表示 - データをCSVから読み込み可能にする - 各メンバーのステータスを一覧で確認できる - レスポンシブ対応（ PC/タブレット） - 基本的なフィルタ（期間、メンバー、プロジェクト） ## タスク - [ ] UI設計（チャート配置・レイアウト） - [ ] データ構造設計（ CSVフォーマット定義、スキーマ） - [ ] バックエンド API設計（データ取得／フィルタ） - [ ] グラフ描画機能の実装（ライブラリ選定） - [ ] CSVインポート機能の実装（バリデーション含む） - [ ] 認証／権限（閲覧制限） - [ ] テスト（ユニット・ E2E） - [ ] ドキュメント作成
7. © 2022 KEEN Inc. 7 仕様や外部情報を docディレクトリにまとめる • 完了した PROJECT.md を格納 ◦ 開発が終わったら、PROJECT.md を doc/ に移動 ◦ 副次的に仕様書が残る ◦ のちの開発で過去の実装が破綻したときにドキュメントに立ち戻れる • DBスキーマも置いておく ◦ doc/schema/table.md にテーブル構造をまとめておく ◦ 複雑なSQLを生成させるときにさせる
8. © 2022 KEEN Inc. 8 まとめ • 開発の前に要件とタスクをPROJECT.mdで整理する • 完了したドキュメントはdoc/にまとめて再利用できるようにする • スキーマなどの外部情報も残しておくと、AI生成がスムーズになる • ドキュメントを活用して開発を効率的にしよう