Japanese Writing
判定基準(誇張・気取り・ぼやけ・非難)が日本語のニュアンスに依存するため、本文は日本語で書く。
読者が開発者である日本語の文書(方針・計画、設計提案、会議資料、issue/PR、チームへの共有文)を、正確に、素直に読める形へ直す。判定は各節の原則で行う。表の例は型を示す見本で、網羅ではない。
Process
- 対象を定める。引数か依頼文にファイルパスが渡されていればそれを読み、なければチャットに貼られたテキストを対象にする。
- 各節の原則を上から順に当てて、直す箇所を拾う。
- 元の意味と構成(見出しの階層、コードブロック、図表)を保ったまま書き換える。見出しの文言はHeadingsの原則で直す。各節の原則で直すのに、原文にない事実か、原文が決めていない読みの選択が要るときは、直さず指摘として報告に回す。この判断が各節の原則より優先する。
- ファイルなら直接書き換えて変更箇所を報告する。チャットのテキストなら、推敲結果をそのまま出す。投稿済みのテキストは、貼り直せる形で出すだけにして、投稿先そのものは書き換えない。
- 投稿・確定の前に2〜4をもう一度当て、改稿のたびに当て直す。1語・1句の小さな直しほど誇張や造語が再混入しやすい。
Don't Overstate
事実より強く書かない。確定していないことを確定したように書かず、確証のあることを不要にぼかさない。因果を主張するなら、なぜそうなるかを一言添える。
| 直す対象 | 直し方 | | ------------------------------------------------ | -------------------------------------------------------- | | 最上級・比較・誇張 | 検証できる事実まで下げる | | 未確定の時期・数値の決め打ち | 確定した分だけ書く | | 範囲や期限の境界が定まらない書き方 | 起点と終点を示し、含めるものを挙げる | | 根拠のない断定 | 推量のまま書く。本文の根拠で確定しているときだけ言い切る | | 検出・保証・解決の「必ずできる」 | 条件を添える(「〜しやすい」「〜が成り立つときに限る」) | | 別物のひとくくり、複数ある原因の一つへの決めつけ | 区別して書く |
Use the Reader's Words
読者がそのまま受け取れる語を使う。判定の順: (1) 読者に通じる定訳や定着した語があればそれを使う、(2) なければ初見で意味が通る素直な語・句に言い換える、(3) どちらも取れない語は英語のまま書き、初出で意味を一言添える。添える説明が本文に対して長くなる短い文書では、意味の幅が狭まっても言い換えに倒す。技術用語の判定は言い回し全体を一つの単位として行う。定型句や複合語(source of truth、baseline)を単語や形態素に分解して部品ごとに訳すと、実在しない語ができる(真実源・基線)。各部品の訳が正しいために、それらしく見えてしまう。分解せず、用語全体で判定する。判定した形は文書内で一つに保ち、分解した部品だけを地の文に英語のまま置かない(見出しがSource of Truthなら、地の文も同じ語で受ける)。カタカナ語は語の一覧で機械的に決めず、どれだけ定着しているかと、周囲の表記(同じ文書・コード・API・分野での表記)との一貫性で、残すか英語にするかを決める。
| 型 | NG → OK | | ------------------------------------------------------------------------ | -------------------------------------------------------------- | | 内輪でしか通じない略し方 | M6目標 → 6ヶ月時点目標 | | 英語の用語を漢字語に直訳(「回帰」「継承」など定着した定訳は除く) | 契約 → Promise、基線 → ベースライン、真実源 → 〜を正とする | | カタカナと直訳の複合語(直訳の部分がふつうの日本語に見えて見逃しやすい) | メジャー更新 → Major update | | 英語をそのままカタカナ書き | アナトミー → Anatomy、トランジション → transition | | 定着したカタカナ語は残す | コンポーネント、トークン、アイコン | | 定訳のない外来語・略語 | クロスリポ → リポジトリをまたぐ、dead → 実際には使われていない | | くだけた略語(通じても技術文書では正式な形に) | スクショ → スクリーンショット | | 漢字を連ねた造語(「最適化」「正規化」など定着した語は除く) | 完成文字列 → そのまま表示できる文字列、活性化 → 有効化 | | 気取った語 | 踏み込んで → 取り組む、Go/No-go判断 → 判定 | | 比喩をそのまま置く(英語の直訳・自分で持ち込んだ比喩のどちらも) | 床 → 下限、信号を出す → 変更を検出する | | 中間の語を落とした圧縮で、主語や目的語がすり替わる | 本文全体を消費する → 本文全体がコンテキストに載る |
Tight and Concrete
一文ずつ、置く理由があるか確かめる。理由がなければ削り、ぼやけていれば具体にする。
| 直す対象 | 直し方 | | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------- | | 同じ主張の繰り返し(言い換え、直後の要約のし直し) | 枠組みだけ残して一つにまとめる | | 後で参照しない固有名、なくても困らない細かさ(時刻、細かい数値) | 削る | | 抽象的な言い方・施策 | 言い換えか具体例を丸括弧で添え、その場で指すものを定める。読者に前を読み返させない | | 受身で行為者が消えた文 | 誰がするのかを主語に立てる。対象を前に出すために選んだ受身は残す |
No Filler
中身を足さず、書けているように見せるだけの言い回しを外す。迷ったら、その文が新しく伝えるのが本題の中身か、文章自身の構成や進み具合かで見分ける。後者しか伝えない文は、短い断定調に整っていても外す。
| 直す対象 | 直し方 | | -------------------------------------------------------- | -------------------------------- | | 予告・総括だけの前置き(「重要なのは〜」「要するに〜」) | 主張を直接書く | | 決め台詞だけの短い段落、「AではなくB」という対句の多用 | ふつうの文に戻す | | 中身のない動詞(深掘りする、言語化する、正面から扱う) | 何をどうするかを書くか、削る | | 中身のない形容詞(鍵となる、根本的な) | 中身を書くか、削る | | 強調語(非常に、極めて) | 削る。程度が要るなら具体値を書く | | 「さらに」「また」「加えて」の連続 | 接続の語なしで並べる |
No Blame
書かれた事柄だけを扱い、人の動機や能力への疑いを混ぜない。過去の失敗を踏まえて書く文書ほど混入する。
| 直す対象 | 直し方 | | ------------------------------------------ | -------------------------------- | | 動機や能力を疑う語(口実に、抱え込む) | 起きた事柄と、必要な手当てを書く | | 個人を特定できる書き方(その人の不在中は) | 役割か構造の記述に直す | | 疑いを前提に組み込んだ条件(利害のない) | 満たすべき条件そのものを書く |
One Topic per Paragraph
段落は一つのトピックに絞る。先頭の文だけで筋を追える順に置き、前提から結論へ一度で進める(論証を前後に往復させない)。
One Point per Sentence
一文には一つのことだけを入れる。読点やダッシュ(—)で節をつないで伸びた複文は文を切り、関係は接続詞か語順で示す。主語と述語を近づけ、間に挟まった修飾・条件・ダッシュの補足は前後の文か丸括弧へ出す。これらで直しても、修飾がどこに掛かるか二通りに読める文は残る。残ったら、掛かり先が定まるまで語順を変えるか、掛かる範囲を丸括弧で示す。読点の位置でも掛かり先は変わるので、位置を動かして別の読みが成り立たないか確かめる。
Consistent Register
敬体(です・ます)と常体(だ・である)を一つの文書内で混在させない。混在していれば多数派の文体に合わせる。見出し・箇条書き・表のセルの体言止めや終止形は混在に数えない。
Headings
見出しは節の中身を指す素直な言い回しにする。二要素(種別と主題など)を詰め込まない。結論を言い切る「セリフ」にしない。
Spacing
和文と半角英数字の間に半角スペースを入れない(「APIで取得」「v2へ移行」)。数詞+助数詞も詰める(「1つ」「3件」)。例外は二つ: 対象そのものか、その置き場所(既存文書、リポジトリ)がスペースを空ける表記で通っていればそれに合わせる(インラインコードの前後だけ空ける流儀も含む)。issue/PR番号参照の直後に和文が続く場合はautolinkが切れないようスペースを挟む(「#12 を修正」)。
Maintenance
表は型の一覧であって、直した語の記録ではない。取りこぼしをこのスキルへ反映するときは、まず既存の行の型に収まるかを確かめ、収まるなら反映しない(例は型ごとに1〜2個で足りる)。既存のどの型でも説明できないときだけ、行を一つ足す。足す前に、近い既存の型と一つの行に統合できないかを先に確かめる。例も行も、増え続けると表が単語リストへ退化し、そこにある語や型しか拾わなくなる。説明文は追記しない。原則で説明できない取りこぼしが出たときに限り、原則の文を書き換える(追記ではなく置換)。表を持たない節(One Topic per Paragraph、One Point per Sentence、Headings、Spacing)はこの原則文の書き換えだけで反映し、例を並べる表を新設しない。セルに収めるために語を圧縮して造語を作らない。セルの文言にも本文と同じ基準を適用する。