生成AI時代のドキュメント基盤¶
ドキュメントの重要性¶
生成AIの活用が進み、ドキュメントの重要性の再認識
生成AI活用にも注目¶
- AWS - Kiro
- GitHub - Spec Kit
- Fission-AI - OpenSpec
- gotalab - cc-sdd
新たな課題の出現¶
ドキュメントの2つの課題¶
- ドキュメント体系
- ドキュメント基盤
ドキュメント体系¶
ソフトウェア開発プロセスの中で
- どのタイミングで
- 何を文章化し
- どうコードとコラボレーションするか
ドキュメント基盤¶
- どのように作成し
- どのようにレビューし
- どのように閲覧し
- どのように配布するか？
2つの視点¶
- ドキュメント体系 : どう構成し、どのように役割分担するか
- ドキュメント基盤 : どのように作成・レビューし、どう閲覧し、どう配布するか
後者が本発表のスコープです。
本ドキュメント基盤の発端¶
- 7年前、MS Officeから脱却を決意
本ドキュメント基盤の発端¶
- 7年前、MS Officeから脱却を決意
- WordやExcelで「きれいに書く事」に時間をかける事が負担
- 複数人で並列作業する事の難しさ
- コードと文書のバージョン同期の難しさ
- 平行作業時のレビューの難しさ
6時間かけて書いたWordが崩壊してキレた¶
Markdownベース文書への移行を決意¶
本ドキュメント基盤の実績¶
- 大手金融3社のSIプロジェクト
- Markdownベース
- 800ページ超
- 最長7年の持続性
これらの事例とノウハウを紹介します。
自己紹介¶
- T.B.D
- T.B.D
ドキュメント基盤要件¶
- AIフレンドリー
- 単純な図の簡便な作成
- 複雑な図を正確に描画
- 表の簡便な作成
- 単一PDF出力
- git管理
- PRベースレビュー
- PR時のステージング
- CI/CD
- 検索を含めた高い閲覧性
- 高い拡張性
- 十分なセキュリティ
- 低コスト
- 保守ステージのコスト0
デモンストレーション¶
デモの流れ¶
- Markdown ファイルの作成・閲覧
- Mkdocs によるサイト閲覧・PDF出力
- Mermaid / draw.io による作図
- Copy To Markdown Excel アドインによる 表の管理
- ソース と ドキュメント の一元管理
- レビュー と ステージング環境
- CI / CD
- おすすめ３機能（MkDocs の検索 / Csv の埋め込み / Marp によるスライド作成）
PDF 出力の流れ¶
