Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ma91n authored Oct 18, 2024
1 parent 33d9c42 commit c33d8fa
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions documents/forMarkdown/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,14 @@ Markdown に限った話では無いが、どういった内容を設計書に

本規約で紹介した各設計ドキュメントの記載内容を参考にしつつ、各開発チームにおいて必要な情報を追加/削除して利用するという、テンプレートとしての利用を想定する。

## テキストベースにおける設計書の注意点

特に扱いで留意すべき点として、列数が多い表形式で設計ドキュメントを記載するケースがある。

Markdownで表を記載することは可能ですが、列数が多い場合は保守性が非常に低くなり、git diffを用いた差分が見れるメリットも下がる。

例えば、1つの画面の利用項目数が数十以上になり得る場合は、Excelなどのファイル形式を利用することを推奨する。

## フォルダ階層の推奨

リポジトリ直下に `docs` フォルダを作成し、その配下に設計ドキュメントとなる Markdown ファイルを配備する。
Expand Down

0 comments on commit c33d8fa

Please sign in to comment.