設計書などドキュメントを作成する場合のセルフチェックポイント
・明瞭性
5W1Hを意識して、特に主語の省略時に意味が通じるかを確認すること
分かりづらい説明には、補足や図表など別枠を用いること
・可読性
1行に複数の要素を含まないこと
可能であれば、箇条書きにする
決められた場所、決められた様式を確認し、遵守すること
既定の様式や記載粒度、記載ルールを確認し、順守すること
表記方法（段落、フォント、行間など）が適切かを再確認すること
・網羅性
記述前に参照元の資料を明確にしておくこと
必要な情報が網羅されているかを再確認すること
必要なモジュールがパッケージされているかを再確認すること
異常系についても忘れないように
・正確性
記述前に参照元の資料を明確にしておくこと
元文書の内容を正しく反映しているかを再確認すること
曖昧なものについてはその旨を明記するか、確定するまで調査すること
不明な点や曖昧な点は、関係者への確認や情報収集を行い、正確な情報を記述すること
・一貫性
用語集を確認し、用語に揺れが無いかを確認すること
他のドキュメントや全体を見直し、言葉遣いに揺れが無いかを確認すること
表記方法（段落、フォント、行間など）に揺れが無いかを確認すること
パッケージする成果物間の関連性に矛盾が無いか再確認すること
標準規約を確認し、遵守しているかを再確認すること
・最新性
元の資料が最新かをチェックする
常に最新のものをチェックアウトしておくこと
作業分担を意識して、他者が更新中のものが無いかを確認すること
パッケージする成果物が最新かを再確認すること
チェットなどで関連の情報を確認し変わっていないかを再確認すること
・保守性
更新履歴や修正箇所などが正しく更新されているかを再確認する
・突発性
イレギュラーな状況や初めての対応には特に注意をすること
想定されるリスクや影響を洗い出し、対応策を検討すること
イレギュラーな状況への対応手順を確認し、慎重に対応すること
過去の事例やトラブルシューティング情報を確認し、問題ないかを再確認すること
Register as a new user and use Qiita more conveniently
- You get articles that match your needs
- You can efficiently read back useful information
- You can use dark theme