ユーザーガイドの翻訳やレビューをするために必要となる、各種ルールを明文化したガイドラインです。
決定したルールから記載してゆき、最終的には翻訳版のガイドラインとマージして、日本ローカルのガイドラインとして置き換える予定です。
当面は翻訳版と併せてお読みいただき、ここに記載されているルールを優先してください。
1. スペース/符号/カタカナの扱い
以下、文字サイズに関する共通認識や慣例に基づき、「シングルバイト文字/マルチバイト文字」の代わりに「全角(文字)/半角(文字)」と表記します。
-
和文の符号文字
& ? ! : ( )
は全角文字で統一する
例: 概念: / コアの標準テーマ(Bartik)では / シティマーケットへようこそ! / リージョンとは? -
全角文字間の半角文字の前後にはスペース(スペースは半角)を入れる(ただし、句読点の前後の場合は入れない)
例: コアソフトウェアは、UNIX/Linux、OS X、Windows 上の Nginx 1.1 以上のバージョンで動作します。 -
半角カッコの外側にはスペース(スペースは半角)を入れ、内側には入れない
例: branding (site name, slogan, and logo) -
全角カッコの外側と内側のどちらにもスペース(スペースは半角)は入れない
例: コアの標準テーマ(Bartik)では -
カタカナ語の表記は、原則として以下のガイドラインに従う
一般財団法人テクニカルコミュニケーター協会発行の「外来語(カタカナ)表記ガイドライン」
https://www.jtca.org/standardization/katakana_guide_3_20150929.pdf
2. 常体(だ・である調)と敬体(です・ます調)、体言止めの使い分け
-
常体、または体言止めで統一する箇所
- タイトル(AsciiDoc: ===, ====)
- [role="summary"] 部(句点で終わる)
- 「前提(前提条件、前提知識など)」部(句点で終わる)
- 「目標」部(句点で終わる)
- 表
- 箇条書き(AsciiDoc: *)
-
敬体で統一する箇所
- 手順(AsciiDoc: 1., 2., ...)や「~とは」部の本文
- 「その他のリソース」部