# 書式

[![badge](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fgezf7g7pd5.execute-api.ap-northeast-1.amazonaws.com%2Fdefault%2Fsource_up_to_date%3Fowner%3Derg-lang%26repos%3Derg%26ref%3Dmain%26path%3Ddoc/EN/dev_guide/doc_guideline.md%26commit_hash%3Da9d45b743cc655543e0d7f586426499091cead3d)](https://gezf7g7pd5.execute-api.ap-northeast-1.amazonaws.com/default/source_up_to_date?owner=erg-lang&repos=erg&ref=main&path=doc/EN/dev_guide/doc_guideline.md&commit_hash=a9d45b743cc655543e0d7f586426499091cead3d)

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

* コードコメント、または内部用のドキュメントは、である調で書く。
* 外部(一般ユーザー)に見せるドキュメントは、ですます調で書く。
* ドキュメント内で初出の用語は、必ず定義や意味、またはリンクを併記する。
* ただし書きとしての()は、補助的ではあるものの本文の理解に必要な文の場合のみ使用し、本文の理解に必須でない文は脚注を使用する[<sup id="f1">1</sup>](#1)。
* ドキュメントの内容が古くなっていた場合は、[この方法](https://github.com/erg-lang/erg/issues/48#issuecomment-1218247362)に従って更新する。
* syntax以下のファイルは、ドキュメントに含めないものを除きファイル名の頭に連番を付ける。
  * 挿入や入れ替えを自動で行うスクリプトがdoc/script内に存在する。

---

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