基本文型
文体
敬体(ですます調)とする
例
OK:我々が提供すべきものはとてもシンプルです。
NG:我々が提供すべきものはとてもシンプルである。
引用したテキストは引用符で囲む
例
YAML がタブを禁止するのはなぜですか?
タブは、エディタやツールによって扱いが異なるため、禁止されています。
重要であることを表現したい場合には太字を使用する
例
カタカナは全角とする。半角カナを使用しないでください。
下線をリンク以外で使用しない
例
OK:基本の検証ブラウザ全てで使用できるかを判断基準としてください。
NG:基本の検証ブラウザ全てで使用できるかを判断基準としてください。
コード例を示す場合は短い場合でも文章中に書かず、ブロックにする
例
<meta name="viewport" content="width=device-width" />ウェブ制作・プログラミング用語単体を文章中で使用する場合は、インラインコードにする。属性名に使用する場合は、属性名のみインラインコードにする
例
https:~、
<p>、
id属性
句読点
句読点はそれぞれ「。」と「、」を使用する
例外 ただし、英文中はピリオド「.」とカンマ「,」を使用する。
文末には句点を付ける
例外 ただし、見出しや箇条書きの文末には句点をつけない
例
- ユーザー視点に立つ。プロダクトをより良くするための指摘であることがわかるようにする