03.ドキュメント規定
このセクションでは、DevBlueprint
で管理される全てのMarkdownドキュメントの品質と一貫性を保つため、その作成、管理、および記述スタイルに関する共通のルールを定めます。
これらの規定に従うことで、ドキュメントは読みやすく、メンテナンスしやすい状態に保たれます。
主要ドキュメント
-
- 目的: ファイルの命名規則、要求IDの利用ルール、Markdownの基本構造など、全てのドキュメントに共通する基本的なルールを定義します。
- 対象者: 全てのドキュメント作成者。
-
- 目的:
mkdocs.yml
によるサイトナビゲーションの管理方法や、ドキュメント間のリンク記述スタイルについて定めます。 - 対象者: 全てのドキュメント作成者。
- 目的:
-
- 目的: ドキュメントの品質を維持するための、プルリクエストベースのレビュープロセスを定義します。
- 対象者: 全てのドキュメント作成者、レビュアー。