文章のルール¶
敬体と常体¶
ですます調にします。
- 誤
pip install jupyter で Jupyter をインストールできる。
- 正
pip install jupyter で Jupyter をインストールできます。
全角と半角¶
全角の英数は使用しません。リテラルを使わない場合は前後のスペース不要です。
日付¶
文章中に日付が必要な場合は以下のフォーマットで記述します。必ず「年」を含めます。
2016年3月14日
2016年12月25日
プログラミングコード中の日付は、可能であれば YYYY-MM-DD とします。
2016-03-14
2016-12-25
言語やライブラリの仕様、その他の制約がある場合はこの限りではありません。
固有名詞¶
固有名詞は大文字・小文字を含めて正確な表記を用います。
- 誤
numPyは行列計算のためのパッケージです。
- 正
NumPyは行列計算のためのパッケージです。
略称を用いる場合は、最初に登場する箇所で正式名称を記述した上で、括弧書きで略称を示します。
World Wide Web Consortium(以下 W3C)は Web技術
Pythonのバージョンが必要な場合はマイナーバージョンを表記し、バージョンの前にはスペースを空けます。
Python 3.5
パッケージのバージョンを示す場合は原則パッチバージョンまで含めます。
NumPy 1.11.0
ただし、MEASURE.MINOR.PATCH でバージョニングされていない場合は配布元のバージョニングに従います。