We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 33d9c42 commit c33d8faCopy full SHA for c33d8fa
documents/forMarkdown/README.md
@@ -38,6 +38,14 @@ Markdown に限った話では無いが、どういった内容を設計書に
38
39
本規約で紹介した各設計ドキュメントの記載内容を参考にしつつ、各開発チームにおいて必要な情報を追加/削除して利用するという、テンプレートとしての利用を想定する。
40
41
+## テキストベースにおける設計書の注意点
42
+
43
+特に扱いで留意すべき点として、列数が多い表形式で設計ドキュメントを記載するケースがある。
44
45
+Markdownで表を記載することは可能ですが、列数が多い場合は保守性が非常に低くなり、git diffを用いた差分が見れるメリットも下がる。
46
47
+例えば、1つの画面の利用項目数が数十以上になり得る場合は、Excelなどのファイル形式を利用することを推奨する。
48
49
## フォルダ階層の推奨
50
51
リポジトリ直下に `docs` フォルダを作成し、その配下に設計ドキュメントとなる Markdown ファイルを配備する。
0 commit comments