Document rule

ドキュメントルールについて

記載有無

• ユーザ見えに影響があるものに関してはドキュメントに記載する。
• ユーザに関係しないもの(コードのリファクタリングなど)に関しては、ドキュメントに記載する必要はない。

英訳

• ドキュメントは「doc\ja」と「doc\en」の両方に記載する。

「doc\en」に英訳を行わない場合は、日本語(Shift_JIS)で下記のようにコメント付きで記載する。

<!-- 日本語のコメント -->

「installer\check_sjis_code.bat」というツールで、未翻訳のファイルを抽出できるようにするためである。

未翻訳のファイルは「doc\en\html*.html」を対象に「<!--」で検索をかけても抽出することができる。（翻訳不要なものも抽出されるが判別は可能）

• 日本語のコメント()を英訳した場合、コメントを除去すること。

• ドキュメントを英訳する時は、翻訳サイトの翻訳結果をそのまま転載しないこと。あくまでも自分の言葉でライティングすること。