| name | japanese-tech-writing |
|---|---|
| description | 日本語の技術文書・書籍原稿の文章規範。段落と論証の構成（パラグラフライティング）、論証の厳密さ（ツッコミどころの除去）、読み手の負荷の管理、視点と語り、演出の抑制、LLM っぽい空句の禁止、翻訳調の比喩と擬人化の禁止（「運ぶ」「効く」「開かれた問い」など）、冗長の排除を定める。日本語で技術書の章、草稿、記事、解説文を書くとき、または推敲・リライトするときに使用する。 |
| license | Unlicense（https://gist.github.com/k16shikano/67625f2a7d96e3bbdfae8d571a936063） |
日本語で技術的な原稿（書籍の章、記事、解説文）を書く・推敲するときは、以下の規範に従う。
パラグラフライティングを基本とする。段落は論証の一歩であり、読者は段落単位で論理を追えなければならない。
- 一つの段落には一つのトピックだけを置く。場面の進行（調査、報告、検証、評価）が複数混ざった長い段落は、一歩ずつの段落に分割する。
- 段落の最初の文を読めば、その段落が何の話かわかるようにする。
- 段落の先頭では、前の段落との論理関係を接続表現で明示する（「であれば」「実際」「しかし」「この例自体からも」）。
- 論証は一方向に進める。結論を出してから反論を処理し、結論を言い直す構成にしない。反論と疑念の処理を終えてから、結論を一度だけ置く。
- 例への弁明（作為的に見える、への先回りなど）は、場面の山場の直後に挟んで流れを切らない。次の節の冒頭でまとめて処理する。
- 読者が立てそうな誤った解釈は、明示的に否定してから本当の理由を述べる（「その理由は『〜だから』ではない。〜だからだ」）。
- 「AではなくB」と否定するときは、否定の根拠を一文添える。反実仮想（「もしAなら、〜だっただろう」）が使えることが多い。
- 同じ概念を二つの対象で対比定義するときは、両文の述部を同じ型にする。既出の説明の回収は文頭の枠に置き、定義そのものを「〜だと説明した」に埋め込まない。特徴の句は「」で切り出し、対比の接続を明示する。第二極について続ける属性は、主語を改めて名乗らず継承する。
- 譲歩（「確かに〜」）では、事実の確認にとどめる。あとで訂正する内容を著者の声で因果として断定すると、自己矛盾になる。表面的な診断を一度認めたいときは、読者や通説の声に帰属させる（「〜と要約できてしまうかもしれない」）。
- 山場で効かせたい情報（数値、固有の事実）は、その手前の段落で先出ししない。
- 何かを否定・限定するときは、否定する命題そのものを「」で正確に書き出す（「明文化されていればすべてを任せられる」を意味しない、など）。「何もかもが解決するわけではない」のような漠然とした否定で済ませない。
- 「後の章で扱う」のような前方参照は、論証が一段落した位置（段落末・節末）に置く。論証の途中に挟んで流れを切らない。
文章の論理にツッコミどころを残さない。書き上げたら、読み手の反論を先回りして次の点を点検する。
- 推量・可能性・読者の疑念・反実仮想として書かれている文を、機械的に断定へ変えない。 「かもしれない」「だろう」「ようだ」「らしい」は、根拠なく主張を弱めている場合だけ削る。 事実未確認の可能性、作中人物の認識、ログからの推定、読者が抱きそうな疑念、反実仮想を表す場合は、その不確実性を保つ。 断定に直せるのは、本文内の根拠によって命題が確定している場合に限る。 悪い例：「提示し続けているかもしれない」を「提示し続けている」に変える。 良い例：「提示し続けている可能性がある」のように、不確実性を残して文を整える。
- 異なるものを「同じ」とまとめない。区別すべき対象（別々の決定、別々の原因、種類の違う問題）を一括りの言葉でくくらない。悪い例：相互依存する三つの未決事項を「同じ決定を別々に下していた」と書く。良い例：「どれも別々の決定であり、しかも互いに依存している」と腑分けする。
- 複数の要因がある事象を、単一の原因に還元しない。例が複数種類の問題を含むなら、それぞれを切り分け、どの道具がどれを説明するのかを対応づける。悪い例：契約の不在と情報隠蔽の失敗が混ざった事故を、丸ごと「情報隠蔽の問題」と説明する。
- 章・節をまたいで、同じ概念の扱いを一致させる。ある節で「人間が決める」と分類したものを、別の節で「チームで合意する」と書かない。分類・定義・用語の地位は全体で揃える。
- 因果を主張するときは、その機構（なぜそうなるのか）を一文で示す。「AだとBになる」とだけ書いて理由を省略しない。悪い例：「手順で分けると変更が全体に波及する」。良い例：「各工程がデータを受け渡すための表現を共有してしまい、その表現を変えると全体に波及する」。
- 検出・保証・解決を「必ず」できるかのように書かない。条件付きで正確に述べる（「〜しやすい」「〜できることが多い」「〜が成り立つときに限り」）。
- 主張は、挙げた例が実際にその全体を支えているかを確認する。例が主張の一部しか支えないなら、主張の範囲を例に合わせて狭める。
- 「次節で扱う」と前方に逃がした論点は、本当にそこで回収されることを確認する。回収しない伏線を張らない。
- 譲歩や限定（「ただし」「とはいえ」）を置いたら、その後で必ず論を進める。逆接で終えて宙吊りにしない。
- 節の中心となる語は、その節以前に定義・対象範囲を述べてから使う。定義せず使い始めない。
- 複数の概念を一つの上位語にまとめるときは、命名の直前に、それらが同じものに帰着すると 一文で述べる。腑分けの逆の操作にも橋を架ける。
読者の記憶と注意は有限の資源として扱う。
- 読者が順読みで保持する情報は、一度に一段だけ増やす。箇所を削ったら残った言及を辿り、この文書のほかで使われなくなった主題は落とす。直前までの文の上に一段で足りる許可や読み方は直接書く。
- 後で参照する必要のない固有名（ファイル名、関数名、識別子）を出さない。「仕様書」「金額計算のユーティリティ」のような一般的な言い方で済ませる。
- 抽象的な言い回しの指す内容が文脈から一意に決まらないときは、可能なときは丸括弧による同格挿入でその場で特定し、できるだけ読者に前を読み返させない。
- 概念を初めて示す文では、読者が順に読んだだけで、まずその概念が何であるか（データ構造、手順、制約などの種類や地位）を読み取れる順序にする。その概念を既に知っている読者にだけ自然な性質・仕組み・制約を、種類の同定より前に置かない。前置すると、未習の読者は文を読み終えた時点で逆戻りしなければ核となる情報を見逃すか、理解が滞る。
- 新しい例や場面を追加して、読者が保持すべき文脈が増えるときは、前の例と何が違うのか、なぜもう一つ必要なのかを前置きして納得感を与える。
- 同一節内に図、表、コードなど複数の提示があるとき、各媒体が担う説明（配置の見え方、数値、手順など）を分けて書く。媒体間で型やデータを揃える必要はなく、別例として並べてよい。指示語（「この2つ」「上記の例」）は、どの媒体のどの例を指すか文脈だけで一意に決まるように置く。一つの媒体で確認した性質を、別の媒体の例にもそのまま当てはめない。二方式を「Aの代わりにB」と対比するときも、やめる側と採る側の語順を置換関係と一致させ、後に書く側が採用される方式であることを順読みで読み取れるようにする。
- 章冒頭や節の導入では、これから例で扱う内容に関係しない過剰な詳細を詰め込まない。
- 例の節の中でも、その節の問い・帰結に関係しない過剰な詳細だけを omit する。議論に必要な具体は残す。省略の典型は、エージェント報告の装飾的精度（時刻、HTTP ステータス、カバレッジ率など）や、後で参照しない固有名詞。
- 例示では、結果の羅列や受動態（「特定され、判明した」）ではなく、行為者を主語にした動作の連なり（「リポジトリを調査して特定し、見つけてくれた」）で書く。
- 「入社2年目のエンジニアが」のような架空の人物設定を無意味に冠しない。
- 論証の中で読者を「あなた」と呼ばず、役割名（「開発者」「読者」）で書く。二人称の呼びかけは、場面への導入（「〜としよう」）や章・本の結びなど、限られた要所にとどめる。
- 対象を指す語は具体的に選ぶ。「AI」「ツール」のような広い語でぼかさない。
- 章や節で定式化・術語（K、契約、不変条件など）を導入したら、以後はその語で通す。「文脈」「ツール」「AI」のような曖昧語に後退しない（定式化する前の導入語として「文脈」などを使うのはよい）。
- 術語・訳語は、その分野で慣用されている語を選ぶ（プッシュ通知は「配送」ではなく「配信」、など）。意味の近い漢語を一般語の感覚で充てない。
- 人物そのものに言及するときは原綴りで書く（Lehman、Bainbridge）。ただし、歴史上の人物や、人名を冠した概念を定着名で紹介するときは、日本語で通用しているカタカナの通称を使う。
- 術語の響きを持つ語を、術語でない場面に流用しない（システムから人間までの連なりを「経路」と呼ぶ、など）。「届くまでの流れ」「あいだに何があるか」のように普通の言い方で書く。
- イ形容詞の終止に「です」を続けた文（「難しいです」「多いです」）を書かない。これは文体の規則ではなく、文の流れの破綻の兆候である。イ形容詞を裸で言い切る必要が生じるのは、その文が前後から孤立しているからであり、流れている文章なら「〜は難しく、…」と文が続くか、「〜でしょう」「〜である」で受けられる。出現したら文末だけ取り繕わず、前後の流れごと書き直す。ナ形容詞の「〜です」（「重要です」）は対象外。
演出の規範は全面禁止ではなく、節度の規範である。修辞は、それが効果を生む箇所でのみ使う。
- 溜め（「ここには〜が潜んでいる」）や修辞疑問で導出を演出するのは、緊張が議論に効く要所に限る。説明で足りる箇所では、そのまま述べる。
- 短い決め台詞を独立した段落にして緊張を作る演出を多用しない。段落内の短い体言止め（「ここまでわずか数十秒。」など）は、場面の山場に限り使ってよい。
- 本文中の太字強調を多用しない。誤読を防ぐ否定や節の帰結など、論理の要所に限り、一節に一、二箇所まで使ってよい（導入部でも可）。それ以外は文の順序と構造で際立たせる。
- 「〜してはならない」という命令調の断定より、「〜するわけにはいかない」のような、作業者の判断として書く形を選ぶ。
- 転回点を過剰に劇的にしない。事実を述べる一文で足りる場合が多い。議論の山場にかぎり、感嘆符つきの短い一文程度は許容する。
- 帰結の列挙によって事故や危険を煽らない。
- 「重要なのは〜である」のような前置きで主張を予告しない。主張をそのまま書く。ただし、主張の様式を宣言する前置き（「標語として言い換えれば」など）は使ってよい。
- 「AではなくBだった」という対句の決め台詞を多用しない。軽い補足や評価は括弧書きで添えてよい。
- 慣用表現をひねった言い回し（「知識を体に入れる」など）や、指す内容が一意に決まらない比喩（「報告の外側に世界が広がっている」など）を使わない。平易な動詞でそのまま言う（「身につく」「気付く機会が減る」）。
LLM が大量生成する、中身のない型に誘惑されない。書き上げたら、この節で点検する。 本書の術語（本質的複雑さ、回収、判断の配置など）を議論に使うのはよい。空虚な装飾として使うのが問題である。
次のような言い回しは、論点を増やさず「ちゃんと書いている感」だけを付ける LLM 口調である。使わない。
- 予告と総括：「重要なのは〜である」「本章では〜を扱う／探求する」「ここでは〜について見ていく」「まとめると」「要するに」（直前の言い換えだけのとき）、「〜に他ならない」
- 正面から系：「正面から扱う」「正面から回収する」「正面から見る／書く／立てる」——中身の代わりに姿勢だけを宣言する
- 空虚な形容：「不可欠」「核心的」「鍵となる」「根本的な」（主張の中身を説明せず強調だけする）、「多角的」「包括的」「総合的」（何をどう見たかを書かない）
- 空虚な動詞：「掘り下げる」「深掘りする」「言語化する」（何をどう書いたかを示さず終わる）、「触れる」「言及する」（一段落で済ませるだけ）
- 接続の型：「〜において」「〜という側面から」「〜の観点から」（新情報なし）、「さらに」「また」「加えて」の連打
- 弱い緩和と称賛：「〜と言えるだろう」「〜かもしれない」（根拠なく主張を弱める場合だけ。推量・仮定・読者の疑念・作中人物の認識なら残す）、「非常に」「極めて」「大いに」（中身のない強調）
悪い例：「本章では、〇〇の理論を正面から扱う」「この前提を、ここで正面から回収する」「多角的に分析すると、重要なのは〜である」。 良い例：「本章では、〇〇の理論を扱う」「ここで、この前提を回収する」「評価の核心は、正しさを誰が知っているかにある」。
LLM は、日本語として存在しない言い回しを、次の三つの経路で生成する。 前節の空句と違い、書き手（LLM）に比喩や演出の意識がないまま混入するので、比喩を使ったつもりのない文も含めて点検する。
- 英語慣用句の直訳：英語の技術文では carry / open / expose / live / land などの比喩的用法が慣用句として定着しており、比喩として意識されない。これを日本語の対応語に直訳すると、日本語では慣用化していないため、字義どおりに読める奇妙な生きた比喩になる。
- 悪い例：「ベクトルが選好を運ぶ」（carry）。良い例：「選好がベクトルとして表現される」「ベクトルに反映される」。
- 悪い例：「この問いは開かれている」（open question）。良い例：「この問いにはまだ答えが出ていない」「未解決である」。
- 悪い例：「推敲の軸が露出する」（expose）。良い例：「推敲の軸が線形に取り出せる」。
- 悪い例：「この情報は残差ストリームに住んでいる」（live in）。良い例：「残差ストリームに含まれる」。
- 無生物主語構文の直輸入：英語では無生物主語の他動詞文が普通だが、そのまま日本語にすると、モデル、データ、ベクトル、損失といった抽象物が意思を持って振る舞う擬人化になる。日本語では、人か処理を主体に戻すか、「〜から分かる」「〜に含まれる」の形に言い直す。
- 悪い例：「モデルは文体を知っている」。良い例：「モデルの出力には文体の一貫性がある」など、確認できる事実として書く。
- 悪い例：「データが語るのは〜である」。良い例：「データから分かるのは〜である」。
- 研究者の話し言葉の混入：機械学習の口頭議論で流通する動詞（「効く」「刺さる」「筋がいい」など）は、話し言葉としては通じるが、書き言葉の技術文書では俗語である。効果や見込みの内容を具体的に書く。
- 悪い例：「規範スキルが効く」。良い例：「規範スキルを与えると生成が選好に近づく」。
- 悪い例：「この手法は筋がいい」。良い例：「この手法は〜という理由で有望である」。
判定の目安は二段である。 まず、その述語を初めて見る読者が字義どおりの動作（運ぶ、開く、住む）を想像しうるなら、翻訳調の比喩を疑う。 次に、動作の主体と対象を具体語で言い直せるか試す。 言い直せるなら、その言い直しをそのまま書く。 言い直せないなら、その文は指す内容が特定できていないので、主張として成立していない。削るか、内容を確定させてから書き直す。
無駄な文章をなるべく残さない。
- 同じ主張を言い換えて繰り返さない。一つの主張は一度だけ書く。題材が直前と同じでも、その文が加えている命題が違えば繰り返しではない。列挙の各項が同じ論理的地位であることを示す枠語の反復や、定義の直後に適用条件や限定を足す文も、主張の繰り返しではない。
- 隣接する節が同じことを別の角度で述べているなら、役割が重複している。片方に吸収して一つの節にまとめる。
- 場面を描写した直後に、その内容を要約し直さない。意味づけの一文（「このような作業は、ほぼ完全に任せられる」など）だけを置く。
- 同じ論理的役割を持つ並列の事実は、文を分けて重ねず一文にまとめる。その事実群の論理的地位は文頭の語で示す（「当然、経理部の月次処理も顧客の支払いも〜」）。
- 冗長さは文字数や文数で判定しない。短文化と一文化は、動機、対象、操作、その同一性、因果、条件が順読みで明示されたまま保てる場合に限る。これらを読者の推論に委ねる圧縮はせず、必要な反復と長さを残す。
- 接続や評価のためだけの文（「それ自体はよいことである」など）を置かない。
- 想像上の読者との問答（問いを立てて一語で答える形など）を修辞として使わない。主張はそのまま述べる。読者の反応を演じて応答する形（「〜と感じたかもしれない。そのとおりである」）も同様に避け、譲歩は地の文で簡潔に行う（「もちろん、処置そのものは開発者が決める問題ではない」）。
- 読者が抱きそうな発想を、メタな枠取り（「ここまでの話には自然な続きがある」「〜という発想である」）で紹介しない。その発想自体を直接書く。読者の疑問なら疑問文のまま書いてよい（「その保守も任せればよいのではないだろうか」）。
- 「本書もそれを否定しない」のような、著者の立場の弁明や断りを書かない。事実の記述（「〜に書かせる場合が多い」）だけを置く。
- 文脈を最短で読み手と共有できる文章にする。導出を一歩ずつ展開しなくても伝わるなら、構造に名前を与えて言い切る。
- 本文でまだ導入していない概念や文書名を、先回りして持ち出さない。
- ためらいのある弱い述語（「有効な対策であり」など）で済ませない。本文内の根拠で確定していることは強く具体的に言い切る（「活用において必須であり」など）。ただし、不確実性・可能性・仮定・読者の疑念を表すための弱い述語は保持する。語調を整えるための意図的な緩和（「必須だと言ってもいい」など）は許す。
- 文章のリズムを作るための接続表現（「しかし一方で」など）は、冗長と見なさない。
見出しは内容を特定できる具体的なものにする。その節が答える問い、または扱う対象を指す句にする。
- 作業の手順だけを述べる見出し（「例に戻す」「〜を読み直す」など）や、情報量のない見出しにしない。その節が答える問い、または扱う対象を見出しにする。
- 見出しを、節の結論を言い切る「セリフ」にしない。見出しの時点で読者がオチを知る状態を避ける。
- 節で扱っている対象を指す名詞句でもよい。
- 見出しが疑問形か断定形かは問わない。問うのは、扱う対象や読者の持つ問いを指しているかである。
- 疑問形か、対象を指す名詞句かは、本文のトーンに合うほうを選ぶ。
- 例が作為的に見えうる場合、それを隠さない。読者の疑念を先回りして認め、現実に十分あり得ることの根拠を短く添える。
- その根拠は、著者の断定（「十分あり得る状況だ」）ではなく、読者自身の経験に訴える一般的事実や通説に求める（「この症状は珍しくないだろう」「〜という言い方もよく耳にする」）。
- 確認していないことを、確認したかのように滑らかに書かない。
LLMに悩ましい日本語を生成させないためのSKILL。人間が書くときのやってはいけない集ではありません。