文字の表記
用字、用語
英数字は半角とする
例
OK:123、button CSS
NG:123、button CSS
カタカナは全角とし、半角カナを使用しない
例
OK:ウェブサイト
NG:ウェブサイト
補助動詞はひらがなで表記する
例
OK:増えてきています。
NG:増えて来ています。
複合の語は漢字を使用し、送り仮名をつける
例
OK:組み込み
NG:組込み、組込
英単語の頭文字は基本的に小文字とする
例外
ただし、固有名詞の場合は提供元または販売元の表記に従う。
英語は原則としてカタカナにする
例
OK:ベーシック認証
NG:Basic 認証
例外
ただし、コード類やよく使う用語(固有名詞に近いもの)は英語表記とする。
例
OK:main ブランチ
NG:メインブランチ
文字の表記と使い分け
略語は基本的に使用しない。使用する場合は、最初に使用する際に正式名称を記載する。ページが変わるごとに新たに記載する
例
Internet Explorer(以下、IE)での検証が不要になり
漢字、ひらがな、もしくはカタカナの表記を変えても意味が変わらない場合、表記の統一に拘る必要はない。その時々の読みやすさを優先してよい
例
今固有名詞の説明で
いま固有名詞の説明で
たったいまひらがなで書いたように
たった今ひらがなで書いたように
例外
表記ゆれ一覧に記載されているものは、その表記に従う。
表記が揺れることがある単語は、補足の文章を付ける。
例
ワークフロー(GitHub Actions)を使用する場合は
スペース
半角スペースは次の場合に使用する
- 英単語間
- 段落末以外のピリオド「.」、カンマ「,」のあと
- 英文中のカッコの外側
例外
ただし、カッコの次にピリオドやカンマが続く場合や文末を除く