はじめに
md ファイルを論理的な観点から検証するpromptをメモとして記録します。
ルール
ルールの詳細についてはrule.txtも参照してください。
長くメンテナンスを行うドキュメントを作成します。
用語は正確に用いる必要があります。
出典は明記する必要があります。
同じ対象は統一的な表現で記述される必要があります。
- 「時間」に関する記述は、RFC 3339に従う必要があります。「今年度末」などという相対表現はやめてください。
- 「らしい」などという曖昧な表現がある場合、根拠を明示しなければなりません。
- 「要件」においては、「RFC 8174」の表現を用いる。
- しばしば、定義セクションを明示することが有効です。
- URLを利用すると、正確に意味を定義しやすいです。
- 正式な用語を使ってください。
- 一般的な動詞も、定義セクションに含めることで、そのドキュメントの範囲内においては専門用語のように扱うことができます。
- 場合分けにおいては、網羅的であるか、網羅的でないなら網羅的でないことを明示してください。
- 例
- 良い場合分け
- 定義的に網羅的
- aの場合
- a以外の場合
- 明示的に網羅的
- 前提: x はaとbの2つの場合しかない。
- xがaの場合
- xがbの場合
- 悪い場合分け
- a,b以外の場合があるか不明。
- aの場合
- bの場合
- 口語ではなく文語を利用してください。「〜で決定する」を「〜でいく」などと、文語で可能な表現を口語で表現しないでください。
- 可能な限り根拠を明示してください。
- 同じ単語は一貫した表記を行ってください。短縮などの別名を用いる場合は、その旨を明記してください。定義セクションに書くことで、定義通りに単語を用いる意識が働き一貫させやすくなります。
- メリットデメリットというような価値判断が伴う場合は、「価値観については省略」と暗黙的な価値判断をしていることを認めるか、具体的な価値基準を明示してください。
- ドキュメントにおいて構造に連続するパターンがある場合は、そのパターンに従ってください。
- 列挙
- 順番のルールについて、パターン内で一貫してください
- 列挙時は粒度や概念の種類を揃えてください。
- 悪い例(railsは言語ではない。また、正式名称のRuby On Railsでない。)
- nodejs
- ruby
- rails
- TypeScript
- 対応パターンを積極的に利用してください。