


コマンドや画面の名前が出てくる技術文書を、分かりやすく翻訳しやすく書く
技術的な説明書や参照ページを書く時に使う。短い文で同じ物は同じ言葉で書き、コマンドやファイル名はそのまま正確に写し、注記・注意・警告を分け、単位・日付・時間帯(タイムゾーン)をはっきり書く。
このAIルールを使うには
## 読む人のやる事に合わせ、短い文と同じ言葉で書く
- 想定読者、その知識、タスク、疑問を特定し、選択肢がある箇所ではトレードオフを説明する。
- 短く完全な文、能動態、現在形を使い、手順には命令形の動詞を使う。
- 概念ごとに1つの用語を使う。馴染みのない用語と略語を定義し、慣用句、俗語、固定観念、地域固有のたとえを避ける。
## コマンドや名前は正確に写し、注記と警告を分ける
- リテラル識別子は、大文字と小文字を含めて正確に保持する。コマンド、ファイル名、パス、インターフェースのラベル、通常の文章を、書体だけに頼らず区別する。
- 意味のある例を使う。実在するアカウント、認証情報、個人データを含めず、地域によって変わる目的があれば説明する。
- 重要な背景には注記、深刻な影響には注意、重大な結果には警告を使い分ける。
## 箇条書きと表の形をそろえ、単位や日付をはっきり書く
- タイトルで内容を要約し、リストを明確に導入し、項目の形式を揃える。番号は手順、優先順位、階層にだけ使う。
- 表は簡潔にし、単位を明記し、SI単位を優先する。数字の表記を統一し、日付、時刻、範囲、タイムゾーンを明示する。
- ページ番号の固定参照ではなく、正確で安定した相互参照を使う。定義は単独で理解できるようにし、用語、包摂性、法的通知、商標を一貫して確認する。
