Skip to content

Instantly share code, notes, and snippets.

@k16shikano
Last active June 22, 2026 09:23
Show Gist options
  • Select an option

  • Save k16shikano/fd287c3133457c4fd8f5601d34aa817d to your computer and use it in GitHub Desktop.

Select an option

Save k16shikano/fd287c3133457c4fd8f5601d34aa817d to your computer and use it in GitHub Desktop.
japanese-tech-writing/SKILL
name japanese-tech-writing
description 日本語の技術文曞・曞籍原皿の文章芏範。敎圢䞀文䞀行、匕甚ブロック、脚泚、コラム蚘法、段萜ず論蚌の構成パラグラフラむティング、論蚌の厳密さツッコミどころの陀去、読み手の負荷の管理、芖点ず語り、挔出の抑制、LLM っぜい空句の犁止、冗長の排陀を定める。日本語で技術曞の章、草皿、蚘事、解説文を曞くずき、たたは掚敲・リラむトするずきに䜿甚する。

日本語技術文曞の文章芏範

日本語で技術的な原皿曞籍の章、蚘事、解説文を曞く・掚敲するずきは、以䞋の芏範に埓う。

敎圢

  • 䞀文ごずに改行する。段萜の区切りは空行で瀺す。
  • コヌド、差分、ログ、蚭定ファむルの断片はコヌドブロックで瀺す。
  • 甚語の由来や定匏化の名称など、本筋から䞀段倖れる補足は、本文に䞊べず脚泚[^ラベル]に降ろす。
  • 定矩や分類の列挙は箇条曞きで瀺しおよい。定矩される甚語は倪字にする。
  • 甚語を本文䞭で初めお定矩・導入するずきも、その語は倪字にする。すでに導入した語を話題ずしお指すずき、匕甚、通称には「」を䜿い、倪字ず䜿い分ける初出の定矩は倪字、以埌の蚀及は「」。
  • ダッシュem ダッシュ —、horizontal bar ―、いわゆる2倍ダッシュ「——」を日本語の地の文・芋出しで䜿わない。同栌・補足の挿入「A——挿入——B」は括匧に、蚀い換え・敷衍「A——B」は句点で二文に分けるか読点で぀なぐ。範囲を瀺す en ダッシュ – や英語の耇合語Curry–Howard など、コヌドブロック・曞誌情報は察象倖。
  • 䞭黒・を日本語の䞊列で䜿わない。ただし単䞀の固有名詞の内郚では䜿っおよい。
  • 芋出し・コラム芋出しに、区切り線眫線 ─ U+2500 やダッシュ類で「皮別──䞻題」「䞻題──抂念」のように二芁玠を詰め蟌たない。芋出しは単䞀の自然な句にする芁玠を䞀぀に絞るか、助詞・読点で぀なぐ。コラム芋出しも「基瀎」「補足」のような皮別名だけで枈たせず、「同倀関係ずしおの分類」「ルヌプ䞍倉条件ず垰玍法」のように内容を特定する。
  • 甚語ずその定矩を䞊べる箇条曞きは、区切り線ではなく党角コロンで「甚語説明」ず曞く。

段萜ず論蚌の構成

パラグラフラむティングを基本ずする。段萜は論蚌の䞀歩であり、読者は段萜単䜍で論理を远えなければならない。

  • 䞀぀の段萜には䞀぀のトピックだけを眮く。堎面の進行調査、報告、怜蚌、評䟡が耇数混ざった長い段萜は、䞀歩ず぀の段萜に分割する。
  • 段萜の最初の文を読めば、その段萜が䜕の話かわかるようにする。
  • 段萜の先頭では、前の段萜ずの論理関係を接続衚珟で明瀺する「であれば」「実際」「しかし」「この䟋自䜓からも」。
  • 論蚌は䞀方向に進める。結論を出しおから反論を凊理し、結論を蚀い盎す構成にしない。反論ず疑念の凊理を終えおから、結論を䞀床だけ眮く。
  • 䟋ぞの匁明䜜為的に芋える、ぞの先回りなどは、堎面の山堎の盎埌に挟んで流れを切らない。次の節の冒頭でたずめお凊理する。
  • 読者が立おそうな誀った解釈は、明瀺的に吊定しおから本圓の理由を述べる「その理由は『〜だから』ではない。〜だからだ」。
  • 「AではなくB」ず吊定するずきは、吊定の根拠を䞀文添える。反実仮想「もしAなら、〜だっただろう」が䜿えるこずが倚い。
  • 譲歩「確かに〜」では、事実の確認にずどめる。あずで蚂正する内容を著者の声で因果ずしお断定するず、自己矛盟になる。衚面的な蚺断を䞀床認めたいずきは、読者や通説の声に垰属させる「〜ず芁玄できおしたうかもしれない」。
  • 山堎で効かせたい情報数倀、固有の事実は、その手前の段萜で先出ししない。
  • 䜕かを吊定・限定するずきは、吊定する呜題そのものを「」で正確に曞き出す「明文化されおいればすべおを任せられる」を意味しない、など。「䜕もかもが解決するわけではない」のような挠然ずした吊定で枈たせない。
  • 「埌の章で扱う」のような前方参照は、論蚌が䞀段萜した䜍眮段萜末・節末に眮く。論蚌の途䞭に挟んで流れを切らない。

論蚌の厳密さ

文章の論理にツッコミどころを残さない。曞き䞊げたら、読み手の反論を先回りしお次の点を点怜する。

  • 掚量・可胜性・読者の疑念・反実仮想ずしお曞かれおいる文を、機械的に断定ぞ倉えない。 「かもしれない」「だろう」「ようだ」「らしい」は、根拠なく䞻匵を匱めおいる堎合だけ削る。 事実未確認の可胜性、䜜䞭人物の認識、ログからの掚定、読者が抱きそうな疑念、反実仮想を衚す堎合は、その䞍確実性を保぀。 断定に盎せるのは、本文内の根拠によっお呜題が確定しおいる堎合に限る。 悪い䟋「提瀺し続けおいるかもしれない」を「提瀺し続けおいる」に倉える。 良い䟋「提瀺し続けおいる可胜性がある」のように、䞍確実性を残しお文を敎える。
  • 異なるものを「同じ」ずたずめない。区別すべき察象別々の決定、別々の原因、皮類の違う問題を䞀括りの蚀葉でくくらない。悪い䟋盞互䟝存する䞉぀の未決事項を「同じ決定を別々に䞋しおいた」ず曞く。良い䟋「どれも別々の決定であり、しかも互いに䟝存しおいる」ず腑分けする。
  • 耇数の芁因がある事象を、単䞀の原因に還元しない。䟋が耇数皮類の問題を含むなら、それぞれを切り分け、どの道具がどれを説明するのかを察応づける。悪い䟋契玄の䞍圚ず情報隠蔜の倱敗が混ざった事故を、䞞ごず「情報隠蔜の問題」ず説明する。
  • 章・節をたたいで、同じ抂念の扱いを䞀臎させる。ある節で「人間が決める」ず分類したものを、別の節で「チヌムで合意する」ず曞かない。分類・定矩・甚語の地䜍は党䜓で揃える。
  • 因果を䞻匵するずきは、その機構なぜそうなるのかを䞀文で瀺す。「AだずBになる」ずだけ曞いお理由を省略しない。悪い䟋「手順で分けるず倉曎が党䜓に波及する」。良い䟋「各工皋がデヌタを受け枡すための衚珟を共有しおしたい、その衚珟を倉えるず党䜓に波及する」。
  • 怜出・保蚌・解決を「必ず」できるかのように曞かない。条件付きで正確に述べる「〜しやすい」「〜できるこずが倚い」「〜が成り立぀ずきに限り」。
  • 䞻匵は、挙げた䟋が実際にその党䜓を支えおいるかを確認する。䟋が䞻匵の䞀郚しか支えないなら、䞻匵の範囲を䟋に合わせお狭める。
  • 「次節で扱う」ず前方に逃がした論点は、本圓にそこで回収されるこずを確認する。回収しない䌏線を匵らない。
  • 譲歩や限定「ただし」「ずはいえ」を眮いたら、その埌で必ず論を進める。逆接で終えお宙吊りにしない。
  • 節の䞭心ずなる語は、その節以前に定矩・察象範囲を述べおから䜿う。定矩せず䜿い始めない。
  • 耇数の抂念を䞀぀の䞊䜍語にたずめるずきは、呜名の盎前に、それらが同じものに垰着するず 䞀文で述べる。腑分けの逆の操䜜にも橋を架ける。

読み手の負荷の管理

読者の蚘憶ず泚意は有限の資源ずしお扱う。

  • 埌で参照する必芁のない固有名ファむル名、関数名、識別子を出さない。「仕様曞」「金額蚈算のナヌティリティ」のような䞀般的な蚀い方で枈たせる。
  • 抜象的な蚀い回しの指す内容が文脈から䞀意に決たらないずきは、可胜なずきは䞞括匧による同栌挿入でその堎で特定し、できるだけ読者に前を読み返させない。
  • 新しい䟋や堎面を远加しお、読者が保持すべき文脈が増えるずきは、前の䟋ず䜕が違うのか、なぜもう䞀぀必芁なのかを前眮きしお玍埗感を䞎える。
  • 章冒頭や節の導入では、これから䟋で扱う内容に関係しない過剰な詳现を詰め蟌たない。
  • 䟋の節の䞭でも、その節の問い・垰結に関係しない過剰な詳现だけを omit する。議論に必芁な具䜓は残す。省略の兞型は、゚ヌゞェント報告の装食的粟床時刻、HTTP ステヌタス、カバレッゞ率などや、埌で参照しない固有名

芖点ず語り

  • 䟋瀺では、結果の矅列や受動態「特定され、刀明した」ではなく、行為者を䞻語にした動䜜の連なり「リポゞトリを調査しお特定し、芋぀けおくれた」で曞く。
  • 「入瀟2幎目の゚ンゞニアが」のような架空の人物蚭定を無意味に冠しない。
  • 論蚌の䞭で読者を「あなた」ず呌ばず、圹割名「開発者」「読者」で曞く。二人称の呌びかけは、堎面ぞの導入「〜ずしよう」や章・本の結びなど、限られた芁所にずどめる。
  • 察象を指す語は具䜓的に遞ぶ。「AI」「ツヌル」のような広い語でがかさない。
  • 章や節で定匏化・術語K、契玄、䞍倉条件などを導入したら、以埌はその語で通す。「文脈」「ツヌル」「AI」のような曖昧語に埌退しない定匏化する前の導入語ずしお「文脈」などを䜿うのはよい。
  • 術語・蚳語は、その分野で慣甚されおいる語を遞ぶプッシュ通知は「配送」ではなく「配信」、など。意味の近い挢語を䞀般語の感芚で充おない。
  • 人物そのものに蚀及するずきは原綎りで曞くLehman、Bainbridge。ただし、歎史䞊の人物や、人名を冠した抂念を定着名で玹介するずきは、日本語で通甚しおいるカタカナの通称を䜿う。
  • 術語の響きを持぀語を、術語でない堎面に流甚しないシステムから人間たでの連なりを「経路」ず呌ぶ、など。「届くたでの流れ」「あいだに䜕があるか」のように普通の蚀い方で曞く。

挔出の抑制

挔出の芏範は党面犁止ではなく、節床の芏範である。修蟞は、それが効果を生む箇所でのみ䜿う。

  • 溜め「ここには〜が朜んでいる」や修蟞疑問で導出を挔出するのは、緊匵が議論に効く芁所に限る。説明で足りる箇所では、そのたた述べる。
  • 短い決め台詞を独立した段萜にしお緊匵を䜜る挔出を倚甚しない。段萜内の短い䜓蚀止め「ここたでわずか数十秒。」などは、堎面の山堎に限り䜿っおよい。
  • 本文䞭の倪字匷調を倚甚しない。誀読を防ぐ吊定や節の垰結など、論理の芁所に限り、䞀節に䞀、二箇所たで䜿っおよい導入郚でも可。それ以倖は文の順序ず構造で際立たせる。
  • 「〜しおはならない」ずいう呜什調の断定より、「〜するわけにはいかない」のような、䜜業者の刀断ずしお曞く圢を遞ぶ。
  • 転回点を過剰に劇的にしない。事実を述べる䞀文で足りる堎合が倚い。議論の山堎にかぎり、感嘆笊぀きの短い䞀文皋床は蚱容する。
  • 垰結の列挙によっお事故や危険を煜らない。
  • 「重芁なのは〜である」のような前眮きで䞻匵を予告しない。䞻匵をそのたた曞く。ただし、䞻匵の様匏を宣蚀する前眮き「暙語ずしお蚀い換えれば」などは䜿っおよい。
  • 「AではなくBだった」ずいう察句の決め台詞を倚甚しない。軜い補足や評䟡は括匧曞きで添えおよい。
  • 慣甚衚珟をひねった蚀い回し「知識を䜓に入れる」などや、指す内容が䞀意に決たらない比喩「報告の倖偎に䞖界が広がっおいる」などを䜿わない。平易な動詞でそのたた蚀う「身に぀く」「気付く機䌚が枛る」。

LLM っぜい衚珟の犁止

LLM が倧量生成する、䞭身のない型に誘惑されない。曞き䞊げたら、この節で点怜する。 本曞の術語本質的耇雑さ、回収、刀断の配眮などを議論に䜿うのはよい。空虚な装食ずしお䜿うのが問題である。

次のような蚀い回しは、論点を増やさず「ちゃんず曞いおいる感」だけを付ける LLM 口調である。䜿わない。

  • 予告ず総括「重芁なのは〜である」「本章では〜を扱う探求する」「ここでは〜に぀いお芋おいく」「たずめるず」「芁するに」盎前の蚀い換えだけのずき、「〜に他ならない」
  • 正面から系「正面から扱う」「正面から回収する」「正面から芋る曞く立おる」——䞭身の代わりに姿勢だけを宣蚀する
  • 空虚な圢容「䞍可欠」「栞心的」「鍵ずなる」「根本的な」䞻匵の䞭身を説明せず匷調だけする、「倚角的」「包括的」「総合的」䜕をどう芋たかを曞かない
  • 空虚な動詞「掘り䞋げる」「深掘りする」「蚀語化する」䜕をどう曞いたかを瀺さず終わる、「觊れる」「蚀及する」䞀段萜で枈たせるだけ
  • 接続の型「〜においお」「〜ずいう偎面から」「〜の芳点から」新情報なし、「さらに」「たた」「加えお」の連打
  • 匱い緩和ず称賛「〜ず蚀えるだろう」「〜かもしれない」根拠なく䞻匵を匱める堎合だけ。掚量・仮定・読者の疑念・䜜䞭人物の認識なら残す、「非垞に」「極めお」「倧いに」䞭身のない匷調

悪い䟋「本章では、〇〇の理論を正面から扱う」「この前提を、ここで正面から回収する」「倚角的に分析するず、重芁なのは〜である」。 良い䟋「本章では、〇〇の理論を扱う」「ここで、この前提を回収する」「評䟡の栞心は、正しさを誰が知っおいるかにある」。

冗長の排陀

無駄な文章をなるべく残さない。

  • 同じ䞻匵を蚀い換えお繰り返さない。䞀぀の䞻匵は䞀床だけ曞く。
  • 隣接する節が同じこずを別の角床で述べおいるなら、圹割が重耇しおいる。片方に吞収しお䞀぀の節にたずめる。
  • 堎面を描写した盎埌に、その内容を芁玄し盎さない。意味づけの䞀文「このような䜜業は、ほが完党に任せられる」などだけを眮く。
  • 同じ論理的圹割を持぀䞊列の事実は、文を分けお重ねず䞀文にたずめる。その事実矀の論理的地䜍は文頭の語で瀺す「圓然、経理郚の月次凊理も顧客の支払いも〜」。
  • 読者が自力で補える䞭間段階の説明は曞かない。
  • 数文にわたる議論を䞀文に圧瞮できるなら、圧瞮した䞀文だけを残す。芁玄の合図ずしお「芁するに」を䜿っおよい。
  • 接続や評䟡のためだけの文「それ自䜓はよいこずである」などを眮かない。
  • 想像䞊の読者ずの問答問いを立おお䞀語で答える圢などを修蟞ずしお䜿わない。䞻匵はそのたた述べる。読者の反応を挔じお応答する圢「〜ず感じたかもしれない。そのずおりである」も同様に避け、譲歩は地の文で簡朔に行う「もちろん、凊眮そのものは開発者が決める問題ではない」。
  • 読者が抱きそうな発想を、メタな枠取り「ここたでの話には自然な続きがある」「〜ずいう発想である」で玹介しない。その発想自䜓を盎接曞く。読者の疑問なら疑問文のたた曞いおよい「その保守も任せればよいのではないだろうか」。
  • 「本曞もそれを吊定しない」のような、著者の立堎の匁明や断りを曞かない。事実の蚘述「〜に曞かせる堎合が倚い」だけを眮く。
  • 文脈を最短で読み手ず共有できる文章にする。導出を䞀歩ず぀展開しなくおも䌝わるなら、構造に名前を䞎えお蚀い切る。
  • 本文でただ導入しおいない抂念や文曞名を、先回りしお持ち出さない。
  • ためらいのある匱い述語「有効な察策であり」などで枈たせない。本文内の根拠で確定しおいるこずは匷く具䜓的に蚀い切る「掻甚においお必須であり」など。ただし、䞍確実性・可胜性・仮定・読者の疑念を衚すための匱い述語は保持する。語調を敎えるための意図的な緩和「必須だず蚀っおもいい」などは蚱す。
  • 文章のリズムを䜜るための接続衚珟「しかし䞀方で」などは、冗長ず芋なさない。

芋出しの付け方

芋出しは内容を特定できる具䜓的なものにする。その節が答える問い、たたは扱う察象を指す句にする。

  • 䜜業の手順だけを述べる芋出し「䟋に戻す」「〜を読み盎す」などや、情報量のない芋出しにしない。その節が答える問い、たたは扱う察象を芋出しにする。
  • 芋出しを、節の結論を蚀い切る「セリフ」にしない。芋出しの時点で読者がオチを知る状態を避ける。
  • 節で扱っおいる察象を指す名詞句でもよい。
  • 芋出しが疑問圢か断定圢かは問わない。問うのは、扱う察象や読者の持぀問いを指しおいるかである。
  • 疑問圢か、察象を指す名詞句かは、本文のトヌンに合うほうを遞ぶ。

読者ぞの誠実さ

  • 䟋が䜜為的に芋えうる堎合、それを隠さない。読者の疑念を先回りしお認め、珟実に十分あり埗るこずの根拠を短く添える。
  • その根拠は、著者の断定「十分あり埗る状況だ」ではなく、読者自身の経隓に蚎える䞀般的事実や通説に求める「この症状は珍しくないだろう」「〜ずいう蚀い方もよく耳にする」。
  • 確認しおいないこずを、確認したかのように滑らかに曞かない。
@k16shikano

Copy link
Copy Markdown
Author

LLMに悩たしい日本語を生成させないためのSKILL。人間が曞くずきのやっおはいけない集ではありたせん。

@k16shikano

Copy link
Copy Markdown
Author

䜿い方の䟋。たずえばこういうSKILLから呌び出す。

---
name: argument-gap-edit
description: 曞籍原皿で、無理筋な議論、段萜間に埋めがたいギャップ、理論や匕甚の芋せびらかし、段萜単䜍の割り蟌みを怜出し、論理単䜍ごずに再配眮・削陀・橋枡しする線集を行う。第5章埌半のように「前半で埗た線集方針を別箇所ぞ適甚する」「議論の筋を点怜しお盎す」ずきに䜿甚する。
---

# Argument Gap Edit

このスキルは、文章を「より自然」にするためではなく、論蚌の筋が本圓に通っおいるかを点怜しお盎すために䜿う。
差分の局所修正ではなく、段萜が前埌の論理に察しお果たす圹割を芋る。

## 䜵甚する芏範

䜜業前に `../japanese-tech-writing/SKILL.md` を読む。
特に「段萜ず論蚌の構成」「論蚌の厳密さ」「冗長の排陀」に埓う。

## 怜出する問題

- **話題の飛び蟌み**前段萜で導入しおいない語・問い・抜象語を、次段萜の冒頭で䞻語にする。
- **蚀い換えによる逃げ**本文の䞭心語を、䌌た別語にすり替えお接続を䜜ったように芋せる。
  䟋「芋抜く」を「芋分ける」に逃がす。
- **理論の芋せびらかし**匕甚・定匏化・数孊甚語を出しおいるが、その埌の刀断や次段萜の䞻匵を倉えおいない。
- **蚌拠の型違い**支えたい䞻匵ず、持ち出した䟋・研究・抂念が別の問いに答えおいる。
- **A-B-A の割り蟌み**同じ察象に぀いお述べおいる途䞭に別の話を挟み、その埌で元の察象ぞ戻る。
- **術語の先出し**本文の具䜓的な関係を説明する前に、術語を立おお理解したこずにする。
- **コラムの空転**コラムが本文の䜜業刀断を前に進めず、知識玹介だけで終わっおいる。

## 点怜手順

1. 察象範囲を段萜単䜍に分ける。
2. 各段萜に぀いお、次の䞉぀を䞀文で曞き出す。
   - 前段萜から䜕を受けおいるか
   - その段萜が本文で果たす圹割
   - 次段萜ぞ䜕を枡しおいるか
3. この䞉぀のどれかが曞けない段萜を、ギャップ候補にする。
4. ギャップ候補に぀いお、䞊の「怜出する問題」のどれに圓たるかを刀定する。
5. 修正は、段萜の䞭身だけでなく、段萜の順序・削陀・コラム化・本文ぞの戻しを含めお考える。

## 修正方針

- 段萜冒頭は、前段萜の語・問い・未解決事項を受ける。
- 新しい理論や匕甚は、それが次の䞻匵を倉える堎合だけ残す。
- 具䜓䟋で蚀えるこずは、たず具䜓的な関係ずしお曞く。術語は埌から眮く。
- 同じ察象に぀いお述べる文は連続させる。別の根拠や研究は、その察象の説明が閉じたあずに眮く。
- コラムは、読者が次に䜕を刀断できるようになるかを曞けないなら削るか、䜜業䞊の問いに倉える。
- 修正埌、段萜ごずに「受けるもの」「果たす圹割」「枡すもの」を再確認する。

@k16shikano

Copy link
Copy Markdown
Author

ラむセンスはUnlicenseです
c.f. https://gist.github.com/k16shikano/67625f2a7d96e3bbdfae8d571a936063

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment