jp-writinglisted

# jp-writing 日本語の Markdown・文書を書く/直すときに常に適用する文章規範。README・技術記事・Zenn・リポ内の解説 Markdown を主対象とする。ソースコード内（.astro, .tsx 等）の日本語にも同じ規範を適用する。 ## 使い方 - **執筆時**: 後述の規範に従って書く。プロジェクトに `context/conventions.md` 等があれば先に読む。書き終えたら「執筆後の点検」を行う。 - **リライト時**: 規範に照らして修正する。「リライトの作法」に従う。 - **Zenn リポ**（`articles/` が存在する）: 修正を終えた記事のフロントマターに `writing-reviewed: true` を付ける。すでに付いている記事は対象外。 ## リライトの作法 デフォルトは keep。直すのは、その箇所を直すことで読者の得が具体的に言える場合だけにする。 個々の修正が正しくても、同じ変換を全箇所へ一律に当てると、その処理の均質さ自体が新しい機械臭になる。元の文書が持つ自然な不揃い（節ごとの濃淡、口語の引用、表記の癖）は欠陥ではなく資産であり、実際に読解を妨げている箇所だけを整える。 ### やらないこと - 著者の主張・論旨を変えない。変えるのは表現だけ - 著者の意図・方針を新設しない。元文書が未解決のまま置いている論点に見解を書き足さない。本文の「未定」を断定に格上げしない - 判断に迷う箇所（意図的な表現か規範違反か区別できない）は修正せず、報告に回す - コミット・push はしない。変更はワーキン���ツリーに残し、ユーザーの指示があったときのみ行う ### 報告 修正後に以下を報告する: - 修正した箇所と理由（規範のどのルールか） - 迷って手を付けなかった箇所（あれば） - Zenn 記事の場合: `writing-reviewed: true` を追加した旨 --- # 規範 ## 文体 - ですます調と、である調の混合を許容する。 - 新規執筆時は、地の文を「ます」調、体験談や所感を「る」調にする程度の自然な混合にする。 ## 整形 - 段落の区切りは空行で示す。 - 段落内では、意味の区切りで改行してよい。一文ずつ機械的に改行しない。ベタ書きもしない。改行位置は書き手の判断に委ねる。 - コード、設定ファイル、ログの断片はコードブロックで示す。 - 定義や分類の列挙は箇条書きで示してよい。定義される用語は太字にする。 - ダッシュ（`—`、`――`）を日本語の地の文で使わない。補足は括弧（）に、言い換えは読点か句点で処理する。 ## 冗長の排除 - 同じ主張を言い換えて繰り返さない。 - 場面や例を示した直後に、その内容を要約し直さない。意味づけの一文だけを置く。 - 接続や評価のためだけの文（「それ自体はよいことである」など）を置かない。 - 読者が自力で補える中間段階の説明は書かない。 - 想像上の読者との問答を修辞として使わない。主張はそのまま述べる。 - 「重要なのは〜である」のような前置きで主張を予告しない。主張をそのまま書く。 - 「この状況を解決するために」のような、次に書く内容を予告するだけの文は省く。 ## LLM口調の禁止 次のような言い回しは、中身のない型である。使わない。単体では日常語のものもあるため、機械的な語狩りではなく頻度と文脈で判断する。 - **予告と総括**: 「本記事では〜を