From c33d8fa0be48b4306472a303a49f05015791c8de Mon Sep 17 00:00:00 2001 From: Junki Mano Date: Fri, 18 Oct 2024 16:48:44 +0900 Subject: [PATCH] Update README.md --- documents/forMarkdown/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/documents/forMarkdown/README.md b/documents/forMarkdown/README.md index cf5e878..cb38921 100644 --- a/documents/forMarkdown/README.md +++ b/documents/forMarkdown/README.md @@ -38,6 +38,14 @@ Markdown に限った話では無いが、どういった内容を設計書に 本規約で紹介した各設計ドキュメントの記載内容を参考にしつつ、各開発チームにおいて必要な情報を追加／削除して利用するという、テンプレートとしての利用を想定する。 +## テキストベースにおける設計書の注意点 + +特に扱いで留意すべき点として、列数が多い表形式で設計ドキュメントを記載するケースがある。 + +Markdownで表を記載することは可能ですが、列数が多い場合は保守性が非常に低くなり、git diffを用いた差分が見れるメリットも下がる。 + +例えば、1つの画面の利用項目数が数十以上になり得る場合は、Excelなどのファイル形式を利用することを推奨する。 + ## フォルダ階層の推奨 リポジトリ直下に `docs` フォルダを作成し、その配下に設計ドキュメントとなる Markdown ファイルを配備する。