# 書式

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

* コードコメント、または内部用のドキュメントは、である調で書く。
* 外部(一般ユーザー)に見せるドキュメントは、ですます調で書く。
* ドキュメント内で初出の用語は、必ず定義や意味、またはリンクを併記する。
* ただし書きとしての()は、補助的ではあるものの本文の理解に必要な文の場合のみ使用し、本文の理解に必須でない文は脚注を使用する[<sup id="f1">1</sup>](#1)。
* ドキュメントの内容が古くなっていた場合は、[この方法](https://github.com/erg-lang/erg/issues/48#issuecomment-1218247362)に従って更新する。

---

<span id="1" style="font-size:x-small"><sup>1</sup> 脚注の書き方はこれを参照すること。 [↩](#f1)</span>