このファイルは、シリーズ全体で表記を揺らさないための用語統一表です。
新しい書籍を作るときは、本文を書き始める前にここを更新してください。
| 採用表記 | 使わない表記 | 補足 |
|---|---|---|
| です・ます調 | である調 | シリーズ本文の基本文体 |
| 参考資料 | 参考文献、参照リンク | 章末見出しは 参考資料 に統一 |
| 初学者 | 初心者 | 学習文脈では 初学者 を優先 |
| 章 | チャプター | 日本語本文では 章 を優先 |
| 節 | セクション | 日本語本文では 節 を優先 |
| 図版 | 図、画像 | 運用文書では 図版、本文では自然なら 図 でもよい |
| サンプルコード | コードサンプル | 見出しやガイドでは サンプルコード |
| 一次情報 | 一次ソース | 章末の資料説明では 一次情報 |
| 用語集 | グロッサリー | 付録名・見出しは 用語集 |
| アンチパターン | 悪い例 | 概念名としては アンチパターン、局所比較では 悪い例 可 |
| 実務 | 現場 | 見出しや説明では 実務 を優先 |
| 判断基準 | 判断軸 | ガイド文書では 判断基準 に統一 |
- 初出では、必要に応じて
日本語(英語)または用語(短い説明)の形で導入する。 - 外国人名は、本文初出を
カタカナ(英語表記)に統一する。章末コラムや補助欄でも、その章で初めて出す人名なら同じ形を使う。 - 同じ章の中で、同じ概念に複数の言い方を混在させない。
- 英語の方が読者に通る場合でも、日本語で意味を固定してから使う。
- カタカナ語を使うときは、読者が連想しにくいなら短い言い換えを添える。
- 製品名、技術名、ライブラリ名は公式表記を優先する。初出で作者や提唱者が読者理解に役立つなら、人名も添える。
- 旧称や旧バージョンの話は、現行名称と混ぜない。
- 電子書籍では、書籍内で触れた章・付録・用語集へ積極的に内部リンクを張る。外部リンクは公式ページを優先し、なければ信頼できる二次情報を使う。
- mdBook 系の書籍では、内部リンク確認を
mdbook-linkcheck --standaloneで標準化する。公開前には外部リンクも確認する。
新しい書籍では、下の表を必要に応じて埋めてください。
| 採用表記 | 使わない表記 | 補足 |
|---|---|---|
| [用語] | [揺れ] | [補足] |
| [用語] | [揺れ] | [補足] |
| [用語] | [揺れ] | [補足] |