仕様書や設計書をWordやExcelではなく、Markdown形式で書き、ソースコードと同じリポジトリ(Git)で管理する運用に変える施策です。ドキュメント生成ツール(Docusaurus, Sphinx等)を使い、コードの変更に合わせてドキュメントも自動ビルド・公開します。ドキュメントと実装の乖離(陳腐化)を防ぎます。
職種 |
情報システム | 施策難易度 |
★☆☆☆☆ |
|---|---|---|---|
業界① |
IT・情報通信 | 目的 |
ナレッジ管理 |
業界② |
ソフトウェアメーカー | 対象 |
テクニカルライター 開発エンジニア |
費用 |
0〜100万円 | 60 |
主なToDo
- ドキュメントの記述フォーマット(Markdown等)を統一する
- CIパイプラインにドキュメント生成・デプロイ処理を組み込む
- 変更履歴(Diff)をコード同様にレビューするプロセスにする
期待できる効果
ドキュメントをコードと同様のワークフローで管理することで、仕様と実装の乖離を根絶。エンジニアが使い慣れたツールでナレッジを蓄積する文化を作り、情報の検索性と鮮度を組織全体で劇的に高めます。
躓くところ
MarkdownやGit操作に不慣れなエンジニア以外の職種を、いかに執筆フローに巻き込むかという教育が困難です。情報の氾濫を防ぐための、文書構成の標準化や定期的な棚卸し体制の維持も課題となります。

開発ドキュメントのコード化(Docs as Code)【ソフトウェアメーカー】






