日本語文書の執筆と推敲の規範

日本語で文書（業務文書、ADR、README、レポート、記事、解説文）を書くときや推敲するときは、以下の規範に従う。 推敲では、まず内容を点検して生成残渣（依頼や会話といった製造過程の痕跡）を除去し、次に表現を文章規範に照らして点検する。 書くときは、最初から両方を満たすように書く。

生成残渣の除去

依頼と会話は文書を作るための材料と経緯であって、それ自体は文書の内容ではない。読者は会話を見ていない。成果物は、その読者が自分に向けて書かれた一つの文書として通読できるものでなければならない。

記述の分類

文書に残す前に、各記述を次の三つに分け、分類ごとに扱いを決める。

• 読者に必要な内容：文書の対象（設計、手順、仕様）について読者が知るべきこと。そのまま残す。
• 書き方への指示：依頼者が伝えた制約、読者層、トーン、避けたい表現。文面には出さず、語彙、構成、手順、例の選び方に反映する。
• 会話の残渣：依頼への応答、修正の経緯、追加の理由、依頼者との合意の確認。削る。

判定の目安は、その記述が指す出来事が文書の対象に属するか、文書を作った会話に属するかである。会話の出来事（指摘、修正、再依頼）は読者の知らない出来事なので残渣になる。対象の出来事（設計の変遷、バージョン間の差）は読者が知るべきことでありうるので、内容として残る。