japanese-tech-writinglisted

# 日本語技術文書の文章規範 日本語で技術的な原稿（書籍の章、記事、解説文）を書く・推敲するときは、以下の規範に従う。 ## 整形 - 一文ごとに改行する。段落の区切りは空行で示す。 - コード、差分、ログ、設定ファイルの断片はコードブロックで示す。 - 用語の由来や定式化の名称など、本筋から一段外れる補足は、本文に並べず脚注（`[^ラベル]`）に降ろす。 - 定義や分類の列挙は箇条書きで示してよい。定義される用語は太字にする。 - 用語を本文中で初めて定義・導入するときも、その語は太字にする。すでに導入した語を話題として指すとき、引用、通称には「」を使い、太字と使い分ける（初出の定義は太字、以後の言及は「」）。 - ダッシュ（em ダッシュ `—`、horizontal bar `―`、いわゆる2倍ダッシュ「——」）を日本語の地の文・見出しで使わない。同格・補足の挿入（「A——挿入——B」）は括弧（）に、言い換え・敷衍（「A——B」）は句点で二文に分けるか読点でつなぐ。範囲を示す en ダッシュ `–` や英語の複合語（`Curry–Howard` など）、コードブロック・書誌情報は対象外。 - 中黒（・）を日本語の並列で使わない。ただし単一の固有名詞の内部では使ってよい。 - 見出し・コラム見出しに、区切り線（罫線 `─` U+2500 やダッシュ類）で「種別──主題」「主題──概念」のように二要素を詰め込まない。見出しは単一の自然な句にする（要素を一つに絞るか、助詞・読点でつなぐ）。コラム見出しも「基礎」「補足」のような種別名だけで済ませず、「同値関係としての分類」「ループ不変条件と帰納法」のように内容を特定する。 - 用語とその定義を並べる箇条書きは、区切り線ではなく全角コロンで「**用語**：説明」と書く。 ## 段落と論証の構成 パラグラフライティングを基本とする。段落は論証の一歩であり、読者は段落単位で論理を追えなければならない。 - 一つの段落には一つのトピックだけを置く。場面の進行（調査、報告、検証、評価）が複数混ざった長い段落は、一歩ずつの段落に分割する。 - 段落の最初の文を読めば、その段落が何の話かわかるようにする。 - 段落の先頭では、前の段落との論理関係を接続表現で明示する（「であれば」「実際」「しかし」「この例自体からも」）。 - 新しい概念・術語を導入するときは、いきなり「XはYである」の辞書型断定で始めない。先に導入文で対象を置き、次にその働き・差分を述べ、必要なら三文目で定義を与える。 - 論証は一方向に進める。結論を出してから反論を処理し、結論を言い直す構成にしない。反論と疑念の処理を終えてから、結論を一度だけ置く。 - 例への弁明（作為的に見える、への先回りなど）は、場面の山場の直後に挟んで流��を切らない。次の節の冒頭でまとめて処理する。 - 読者が立てそうな誤った解釈は、明示的に否定してから本当の理由を述べる（「その理由は『〜だから』ではない。〜だからだ」）。 - 「AではなくB」と否定するときは、否定の根拠を一文添える。反実仮想（「もしAなら、〜だっただろう」）が使えることが多い。 - 譲歩（「確かに〜」）では、事実の確認にとどめる。あとで訂正する内容を著者の声で因果として断定すると、自己矛盾になる。表面的な診断を一度認めたいときは、読者や通説の声に帰属させる（「〜と要約できてしまうかもしれない」）。 - 山場で効かせたい情報（数値、固有の事実）は、その手前の段落で先出ししない。 - 何か