Deep Insider 文章スタイルガイド (執筆者さまへ)

Deep Insider 文章スタイルガイド (執筆者さまへ)

  • このエントリーをはてなブックマークに追加

Build InsiderはDeep Insiderと共通の文章スタイルを採用しています。

<目次>
  • 2013/04/24[初版] Build Insider向けの初版(編集部スタッフが@IT Insider.NETと共通ということもあり、当初は@ITとできるだけ共通的な文章スタイルを設定しましたが、初版当時以降の@ITの文章スタイルの変更には追従していません。両サイトで執筆されている方はご注意ください)
  • 2018/01/22[改訂] Deep Insiderと共通化
  • 2018/01/27[追記] 第4章・第5章・第6章を追加

 本文書では、用語用字の統一基準や、記号やカッコの使い分け基準といった文章の書き方をまとめています。

 ドキュメントフォーマットや原稿の受け渡し方法など、Deep Insiderでの執筆から公開までの手順・方法については、下記リンク先で説明していますので、こちらも併せてご参照ください。

▲目次に戻る

第1章 文章スタイル(基本)

 第1章では、最も基本的な文章スタイルをまとめています。執筆者の方は、最低限、この章の内容を踏まえて執筆していただけると、編集部による校正が少なくなるので助かります。

基本は「だ・である調」

 Deep Insiderでは基本的に「だ・である調」で統一しています。

 「です・ます調」の方が丁寧な印象があり一般的ですが、技術文書なので簡潔さを重要視して「だ・である調」を選択しています。特別な理由がなければ、「だ・である調」での執筆をお願いしています。

 ただし表現上の理由から、意図的に「です・ます調」を使うことは可能です。例えばオピニオンコラムなど技術内容ではない文書の場合や、技術文書であっても語りかけるような書き方だったりする場合は、「です・ます調」を採用することが考えられます。

段落と改行

 前後に空白行がある場合は(形式上の)段落(HTMLの<p>タグ)になり、ない場合は改行<br>タグ)になります。

 Web媒体では紙媒体よりも段落分けをより細かく行った方が読みやすいことが多く、目安としては3文前後での改行をお勧めしています。

[例]


次の行は単なる改行。
この行では段落は開始されない。

上下に空白行があるのでここは段落になる。

字下げ

 Deep Insiderでは、原則として字下げを行っています。段落先頭の全角1文字下げをお願いします。

 なお、字下げは「段落を明示するためなので、Webでは不要」という主張があることは承知していますが、Deep Insiderでは「字下げ」と「前後空白行による(形式上の)段落」の両方が適切に行われているものを(意味上の)段落として扱っていますのでご了承ください。

[例]


 次の文は、

字下げがないので、意味的には「段落内の文の続き」と解釈され(HTML上の形式的には<p>タグによる段落になっている場合がある)、

実際にはこの行で意味上の段落が終了している。

 ここは「字下げした前後空白行」なので、意味的には新しい段落となる。

句読点

 句点(くてん)は全角の、読点(とうてん)は全角のとします。

 ちなみに、編集部で校正する内容になりますが、紛らわしいの使い方として、後述の「箇条書き+コロン(:)に関する注意点」があります。

英数字

 アルファベットや数字は、特別な目的がない限り、全て半角文字をお使いください。

記号

 ( )などの記号類は、特別な目的がない限り、全て全角文字をお使いください。

製品名

 製品名は、一字たりとも変えずに正確に表記してください。これは文章スタイルのルールに従う必要はありません。

[例]

  • サービス名: 「Google検索」(×「グーグル検索」は不可)
  • 製品名: 「Windows OS」(×「ウィンドウズOS」は不可)
  • サービス名: 「Microsoft Azure」(×「マイクロソフトAzure」は不可。2語で1つのサービス名を形成しているので)

会社名

 会社名も、一字たりとも変えずに正確に表記してください。

 海外企業などでも日本名があり日本で一般的に広く認知されている会社の場合は、原則として日本名で表記してください。

 また、会社名かサービス名かが分かりにくい場合は、会社名の方に「○○社」とを付けて区別してください。

[例]

  • 日本名がある会社: 「マイクロソフト」(「Microsoft」という英語表記よりも日本語表記を優先させる)
  • 日本名がある会社: 「ゴールドマン・サックス」(「Goldman Sachs」という英語表記よりも日本語表記を優先させる)
  • 日本名がない会社: 「Alphabet」(×「アルファベット」という日本名は存在しないので不可)
  • 日本名がない会社: 「Slack社」(「Slack」はサービス名でもあるので、会社名として表記したい場合には「社」を付けるのが好ましい)

コードタグ

 本文中に表記されるクラス名などのコード関連のほぼ全てを、HTML上では<code>タグで囲んで表現しています。実際に左記の<code>がそのタグで表現されています。

 これをMarkdownで表記するには、本文中で`Abc("aaa")`のように`で囲んでください。サイト独自のフォーマットで記載する場合には、本文中で◎Abc("aaa")◎と記載してください。

カスタム表現

 HTML上などでカスタム表現してほしいことがあれば、★これでコメント★のようにで囲んでを書いていただければ、その部分はHTML制作時に内容を見て手動でHTML化します。

 ちなみに斜体は非推奨としています。

▲目次に戻る

第2章 用字用語統一ガイドライン

 用字用語統一は校正段階で編集部が行います。執筆者の方は、用語用字統一を意識して行う必要はありません。

 この章は、「具体的にどのようなルールに基づいて校正しているか」を、あらかじめご理解・ご了承いただくために、その内容を明文化したものです。

1日本語表記は基本的に『共同通信社 「記者ハンドブック」新聞用字用語集』(最新版、2018年1月時点では第13版)に準拠

 記者ハンドブックでは、「漢字と平仮名のどちらを使うか」や、同音異義語の使い分けなどの指針がまとめられています。書き文書の汎用的なスタイルガイドとしてメディアを中心にさまざまな業界で採用されており、一般的な文章スタイルと言えます。

 ただし難点として、縦書き中心の新聞寄りの用語用字統一になっていますので、Webのような横書き中心のメディアでは違和感のある用語用字統一も多々あるかもしれません。記者ハンドブックと同じような用字用語統一を独自に規定して履行するのは難しいため、手軽な統一化ツールとして採用しています。ご了承ください。

2外来語のカタカタ表記は、原則として語尾が『-er』『-or』『-ar』で終わる語彙は長音を付ける。『-y』で終わる語彙は長音を付けない

[例]

  • ×カウンタ → カウンター
  • ×エクスプローラ → エクスプローラー

 このルールは、「1991年の国語審議会の答申を受けて出された内閣告示に基づく外来語の表記ルール」に基づいています。

 ただし、「スリッパ-(Slipper)」のように長音を付けると意味が通じにくくなるものに関しては、「スリッパ」という慣用表現を優先します。このルールは1のガイドラインよりも優先されます。

3外来語のカタカタ表記における単語区切りには、基本的に極力、中黒(・)や半角空白( )を使わない

[例]

  • network computer → ネットワークコンピューター
  • default gateway → デフォルトゲートウェイ
  • ネットワークコンピューター(中黒) → ネットワークコンピューター
  • ネットワーク コンピューター(半角空白) → ネットワークコンピューター

 ただし、以下のようの場合は例外となり、中黒(・)を用いてもOKです。このルールは1のガイドラインよりも優先されます。

例外ルール(例)

  • 外国人の名と姓の間には入れる(ウィンストンチャーチル)
  • 固有名詞と普通名詞からなる語は入れる(マイクロソフトプラットフォーム)
  • 長くて判読しにくい語には入れる(コネクションレスインプリメンテーション)
  • 原則として上記以外の2語の場合は入れない(システムインテグレーター/フラッシュストレージ)
  • 3語以上からなる語には入れる(ユーザーインターフェイスガイドライン)

 例外として、画面上の表記や正式名称などは、カッコ書きの中で、可能な限り表記どおりに記載します。要するに、半角スペースや中黒などを使うことが可能です。後述の5や「カッコ書きの使い方」で説明しています。

4製品機能の名称・訳語などは、最新の公式ドキュメントで用いられる訳語(=最も多い訳し方)に合わせる

 例えばマイクロソフト製品機能の名称・訳語などは、最新の「公式ドキュメント」で用いられる訳語(=最も多い訳し方)に合わせてください。このルールにより、マイクロソフト用語との一貫性を保ちます。マイクロソフト以外の製品における名称・訳語などは、各製品の公式ドキュメントの訳語に合わせます。

 このルールは123のガイドラインよりも優先されます。

5「カッコ内では用語統一しなくてもよい」例外条件があります

 第3章で説明する、画面上の項目に使う[ ]や、書籍タイトルなどに使う『 』、記事タイトルに使う「 」の中は、用語統一ルールに従わず、できるだけ項目表記やタイトル表記に忠実に記載してください。

 このルールは1234のガイドラインよりも優先されます。

6ケースバイケースで、記事内統一(=各記事内の独自基準により用語や文章スタイルを統一)を行う

 このルールは12345のガイドラインよりも優先されます。

▲目次に戻る

第3章 記号/カッコの使い分け指針

 紛らわしくて迷いやすい、記号とカッコ書きの使い分け指針をまとめておきます。

記号の使い方: … : ・ 、 / ―

 繰り返しになりますが、( )などの記号類は、特別な目的がない限り、全て全角文字をお使いください。それ以外には以下のようなルールや使い分け指針を定義しています。

3点リーダー(……)

 3点リーダーは、言い切らない文章などに使われます。日本語で表現する箇所では……と表記し(は2文字連続させて使うのが一般的)、英語表現では...半角ドット3つ)で表記します。

コロン(:)とセミコロン(;)

 セミコロンは主に区切りを意味しますが、日本語文章の箇所には使用しないでください。

 コロンは原則として、以下のように「具体的な例示(すなわち)」を意味する用法で使用してください。

[例]

  • コロンの役割: 左の語句の具体例や、説明、定義などを書く。
箇条書き+コロン(:)に関する注意点

 箇条書きの最後には、原則としてを付けません。ただし、項目内にを「具体的な例示(すなわち)」を意味する用法で使って続く文章が記載されている場合、その文章に対してを付けることはできます。

[例]

  • ×箇条書きの各項目の末尾にはを付けけない
  • 箇条書きの各項目の末尾にはを付けない
  • 「具体的な例示(すなわち)」の意味でに続く文章がある場合 その文章に対してを付けることは可能
  • ×ただし、箇条書き項目の末尾にはを付けることはできない ここからは具体的な例示を行う文章であり、「箇条書き項目の文ではない」と見なしているため、を付けることは可能
中黒(・)と読点(、)とスラッシュ(/)の使い分け

 単語を列記する場合、を使うことがあります。これは以下の基準で使い分けてください。

  • : 名詞の列記。動詞は列記できません。原則としてAND条件(例えば「A・B・C」は「AとBとC」を意味する)でのみ使用します。
  • : 名詞や動詞を列記する場合は読点を使用します。原則としてAND条件でのみ使用します。
  • : 名詞もしくは動詞の列記。原則としてOR条件(例えば「A/B/C」は「AやBやC」を意味する)でのみ使用します。

[例]

  • 名詞: 日本語・英語・フランス語が使える。=日本語と英語とフランス語が使える。
  • 名詞: 日本語、英語、フランス語が使える。=日本語と英語とフランス語が使える。
  • 名詞: 日本語/英語/フランス語が使える。=日本語や英語やフランス語が使える。
  • 動詞: 拝読、拝聴する。=拝読し、かつ拝聴する。読点の代わりに、中黒は使用できない。
  • 動詞: 拝読/拝聴する。=拝読するか、拝聴する。スラッシュも使用可。
ダッシュ(―)

 左は全角ダッシュです。見た目では気付きにくいですが、全角ハイフンや長音と違うので注意してください。ダッシュは単なる装飾であり、特に意味はありません)は、原則として――と、ダッシュを2文字連続させて使用します。利用場面はあまりありませんが、以下のようにして使用できます。

[例]

  • 目立たせたい挿入文: アジア――特に日本は――は
  • QAなどの質問者の発言: ――質問ですか?

カッコの使い方: [ ]「 」『 』( )< >

 一部のカッコ書きに対して、Deep Insiderでは以下のように使い方を定義しています。

[ ]の使い方: キーボード入力

 キーを押す場合は、[ ]を使って以下のように表記します。

[例]

  • [Enter]キー
  • [Shift]+[F5]キー
  • [Ctrl]+[Shift]+[Delete]キー
[ ]の使い方: 画面上の項目の表記

 ウィンドウやダイアログ、Webページ上の項目などは、[ ]を使って以下のように表記します。[ ]は、原則的に、半角空白も含めて画面表記と全く同じように記載します。

[例]

  • [コマンド プロンプト]ウィンドウ
  • [オプション]ダイアログ
  • Webページ上にある[スマートフォン用表示に変更]ボタン

 メニューなど、階層式の画面項目は、[ ]-[ ](全角ハイフン、全角マイナス)を使って以下のように表記します。

[例]

  • [スタート]メニューから[全てのプログラム]-[アクセサリ]-[メモ帳]
  • メニューバーの[ファイル]-[開く]-[プロジェクト]
  • [デザイン]タブの[透かし]-[社外秘]

 なお、画面上の項目で、(N)のようなアクセスキーの表記や、...という別UI継続(=続けて別のUIが表示されること)を明示する表記は省略してください。ただし、[...]のような単独表示は省略しないでください。

[例]

  • アクセスキーの表記は省略: ×[送信(S)]ボタン → [送信]ボタン
  • 別UI継続の表記は省略: ×[選択...]ボタン → [選択]ボタン
  • 別UI継続の単独表記は省略しない:[...]ボタン
「 」と『 』の使い分け

 カギ括弧と二重カギ括弧は、以下のように国語の原稿用紙の使い方と同じです。

[例]

  • 『書籍のタイトル』
  • 「かっこの『中の』カッコ」
  • 「会話文」

 データなどの入力値は「 」もしくは太字で表記します。ただし、カッコが多すぎる状態にならないように、基本的には太字を使用してください。

[例]

  • [名前]欄に本田と入力する(推奨)
  • [名前]欄に「本田」と入力する(使用可)
( )の使い方

 ( )は文章中の補足説明などで使います。ただし、補足説明が長くなる場合は、*1のような脚注で記述することを検討してください。

 一文全体に対する補足説明の場合は、原則として以下のように句点の前に挿入してください。

[例]

  • 一文の末尾のの前に入れる(補足説明)。

 一文の中の文節に対する補足説明の場合は、原則として以下のように読点の前に挿入してください。

[例]

  • 文節がいくつかあるので(補足説明)、該当する文節の末尾のの前に入れる。

 語句に対する補足説明の場合は、原則として以下のようにその語句の直後に挿入してください。

[例]

  • 何らかの語句(補足説明)の直後に入れる。

 ( )は以下のように文節の省略補完に使用しても構いません。

[例]

  • これは(暗に意味されている言葉などの省略を補完している文節で)補足説明ではない。

 省略補完か補足説明か紛らわしい場合がありますが、そのようなケースの補足説明では(= )として、前の語句の補足説明であることを明記してください。

[例]

  • これは何らかの語句(=補足説明)であり、省略補完ではない。
< >の使い方

 状況や環境によって異なる箇所は、以下のように< >書きでその箇所の意味や説明などを記載します。なお、< >は記号であるため原則的には全角文字で記載しますが、英語部分に含まれている場合は原則として半角文字で< >と記載してください。

[例]

  • 日本語表記: C:\Users\<ユーザー名>\Documents
  • 英語表記:C:\Users\<User Name>\Documents

 また、特にコマンドの利用法を説明する際には、半角文字の[ ]を使ってオプション指定(=指定してもしなくてもよい)を、半角文字の{ | }を使って選択指定(=いずれか1つを選択して指定)を表現してください。

[例]

  • copy [/d] [/v] <コピー元のファイル> [<コピー先のファイル> [{/a|/b}]]

▲目次に戻る

第4章 ひらがなと漢字の使い分け指針

 ここでは特に間違いが多い「ひらがな」か「漢字」かの使い分けを、品詞別の視点で紹介します。

「形式名詞」=ひらがな、「名詞」=漢字

 原則として、抽象的な意味の「形式名詞」はひらがなに、実質的な意味の「名詞」は漢字にします。以下はその代表的な例です。

「とおり」の[例]

  • 抽象的な意味: いつもどおり
  • 実質的な意味: 通りへ出る

「たび」の[例]

  • 抽象的な意味: 走るたび
  • 実質的な意味: 重なる

「こと」の[例]

  • 抽象的な意味: 書くこと
  • 実質的な意味: と次第によっては

「もの」の[例]

  • 抽象的な意味: いろんなもの
  • 実質的な意味: を置く

「とき」の[例]

  • 抽象的な意味: 都合のよいとき「~の場合に」と言い替えられる)
  • 実質的な意味: として(時期や時間を示し、上のように言い替えられない

「ころ」の[例]

  • 抽象的な意味: 10時ごろ接尾語的に日時や時間の後に付ける用法)
  • 実質的な意味: 学生の名詞)

▲目次に戻る

第5章 数値・単位表現

 ここでは特に間違いが多い「ひらがな」か「漢字」かの使い分けを、品詞別の視点で紹介します。

数字表記

 原則として日本語文章部分では,桁区切りは入れません。代わりに、などの漢字桁区切りを入れます。ただし、英語の単位が付く場合は、,桁区切りを入れてください。

[例]

  • 「123456円」(×「12,3456円」は不可)
  • 「123,456,789Bytes」(×「123456789Bytes」は不可)

数字に付く「カ」

 大文字のや、小文字のは使いません。大文字のを使います。

[例]

  • 「3月」(×「3月」や「3月」は不可)
  • 「3所」(×「3所」や「3所」は不可)
  • 「該当所」(この「箇所」は場所を表す漢字の単語)

単位表記

 原則として単位は英語表記を使ってください。その場合、前述のとおり、桁区切りも英語仕様になります。単位の単数形/複数形も英語と同じ文法を採用しています。見にくい場合は、数字と単位の間に半角スペースを入れてもOKです。

 読者層にとって、英語の単位表記になじみがないことが予想される場合は、初出の場所で丸カッコ書きで補足説明を挿入してくさい。例えば「123nm(ナノメール)」のような形で記述します。

 注意点として、bitは小文字、Byteは大文字で区別しています。よって、MbMegabitという意味になり、MBMegaByteという意味になります。

 例外として、通貨単位は日本語表記を仕様してください。米国以外のドルには国名を入れて豪ドルのように表記してください。

[例]

  • 「8bits」「8 bits」「8-bit
     (「8ビット」よりも優先させる。×1文字の単位は分かりにくいので「8b」は不可)
  • 「123Bytes
     (「123バイト」よりも優先させる。×1文字の単位は分かりにくいので「123B」は不可)
  • 「123KB」「123MB」「123GB」「123TB」「123PB
     (「123KBytes」~「123PBytes」よりも優先させる)
  • 「123nm」「123mm」「123cm」「123m」「123km
     (「123ナノメートル」~「123キロメートル」よりも優先させる)
  • その他「123kW」「123Mbps」「1GHz」「60fps」「100mAh」など
     (ここまでと同様に日本語の単位表記よりも優先させる)
  • 「123」「123」「123ドル」「123豪ドル」「123スイスフラン」「123ポンド」「123ユーロ
     (\123」「CH\123」「$123」「A$123」「S₣123」「£123」「123」よりも優先させる)

▲目次に戻る

第6章 よくある間違いやすい表現

「づつ」ではなく本則の「ずつ」を使う

  • × 少しづつ
  • 少しずつ

「Simulation」に対応する外来語

  • × シュミレーション
  • シミュレーション

「Monolithic」(一枚岩)に体操する外来語

  • × モノシリック
  • モノリシック

「敷居が高い」の用法

 「敷居が高い」は「相手に不義理などマイナスのことをしたので行きにくい」という意味です。「自分には難しい」という意味で用いる人が多数ですが、そういう場合は「ハードル」などを使うのが適切です。

  • × 業界参入の敷居は低い ⇒  業界参入のハードルは低い
  • 迷惑ばかりかけているので、伯父の家を訪れるのは敷居が高い

「うがった見方」の用法

 「うがつ(穿つ)」は「穴を開ける」という意味なので、「うがった見方」は「物事の本質を捉える鋭い視点で見ること」という意味になります。「疑ってかかる見方」「ひねくれた見方」という意味で使われているケースが多々あり、例えば「これは私のうがった見方だが」と書くと、「自分の視点は鋭い」と自画自賛していることになります。

  • × これはうがった見方かもしれないが ⇒  これはひねくれた見方かもしれないが/これは疑ってかかる見方かもしれないが
  • 君はうがった見方をするね。(褒めている)

サイトからのお知らせ

Twitterでつぶやこう!