ドキュメントを Markdown で書いて docs/ 配下で管理する

ドキュメントを Markdown で書いて docs/ ディレクトリ配下で管理する方針にしている話をご紹介します。

docs/spec.md

背景 ドキュメントを Markdown で書いて git 管理している

仕様などのドキュメントを Markdown で書いて git 管理していまして docs/ ディレクトリ配下に、

docs/spec.md

みたいな感じで管理していることをご紹介するだけの記事です。

docs/ 配下でドキュメント管理している事例

以上、開発プロジェクト毎のドキュメント管理はソースコード管理している git に docs/ ディレクトリを作成して Markdown で書いていきたい、現場からお送りしました。

関連記事