erg/doc/JA/dev_guide/doc_guideline.md

書式

以下のルールに従っていないドキュメントはすべて修正の対象となる。

• コードコメント、または内部用のドキュメントは、である調で書く。
• 外部(一般ユーザー)に見せるドキュメントは、ですます調で書く。
• ドキュメント内で初出の用語は、必ず定義や意味、またはリンクを併記する。
• ただし書きとしての()は、補助的ではあるものの本文の理解に必要な文の場合のみ使用し、本文の理解に必須でない文は脚注を使用する¹。
• ドキュメントの内容が古くなっていた場合は、この方法に従って更新する。

---

¹ 脚注の書き方はこれを参照すること。↩