From 5cfc9ffc75dab440159701dbe3cd6bdd1ffbf92b Mon Sep 17 00:00:00 2001 From: Junki Mano Date: Fri, 18 Oct 2024 16:21:45 +0900 Subject: [PATCH] Update README.md --- documents/forMarkdown/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/documents/forMarkdown/README.md b/documents/forMarkdown/README.md index 98aa5d31..6c6d0c4a 100644 --- a/documents/forMarkdown/README.md +++ b/documents/forMarkdown/README.md @@ -30,11 +30,11 @@ Markdown に限った話では無いが、どういった内容を設計書に 本規約はそれらを否定するものではなく、様々な利害関係者の要求に応え洗練され続けた上記の設計ドキュメントのテンプレートには、強く敬意を表する。 -一方で、設計ドキュメントを精緻に管理していく優先度より、プロダクト開発の効率とビジネスピードをより重視する場合もあり、それらの開発チームでは設計ドキュメントが存在さいない、あっても設計書が実装と乖離しているなどの声も多い。 +一方で、設計ドキュメントを精緻に管理していく優先度より、プロダクト開発の効率とビジネスピードをより重視する場合もあり、それらの開発チームでは設計ドキュメントが存在さえない、あっても設計書が実装と乖離しているなどの問題が世間で課題提起されることも多い。 -本規約では、後者のプロダクト開発の効率性を重視し、設計ドキュメントが開発以外の観点から求められない場合において、必要最低限必要だと思われるレベルの記載内容を示す。 +本規約では、後者のプロダクト開発の効率性を重視し、設計ドキュメントが開発以外の観点から求められない場合において、必要最低限必要だと思われるレベルの記載のサンプルを提供する。 -設計ドキュメントのファイルフォーマットに制約は無いという前提に立つため、設計ドキュメントの陳腐化を防ぐのに有効だと思われる、テキストベース（Markdown）でGit管理するという思想を採用する。 +また、設計ドキュメントのファイル形式に制約は無いという前提に立つため、設計ドキュメントの陳腐化を防ぐのに有効だと思われる、テキストベース（Markdown）でGit管理するという思想を採用する。 本規約で紹介した各設計ドキュメントの記載内容を参考にしつつ、各開発チームにおいて必要な情報を追加／削除して利用するという、テンプレートとしての利用を想定する。