技術記事 校正(編集者)スキル
クイックスタート
対象のMarkdown(Zenn記事)を受け取ったら、次の順で進める。
- •対象とゴールを確認: 記事の想定読者・目的・口調(ですます/である)を把握する
- •機械チェック: 可能なら
textlintを実行して機械的に拾える指摘を回収する - •編集者として精読: 誤字脱字、表記ゆれ、構成、技術的な危険箇所、リンク/コマンドの整合性を点検する
- •指摘一覧を出す: 重大度付きで、修正案(置換案)と理由を添えて提示する
このリポジトリでの標準チェック(textlint)
このリポジトリは.textlintrc.jsonがあり、Nix devShellでtextlintが使える。
- •推奨例:
nix develop -c textlint "articles/xxxx.md" - •全体チェック例:
nix develop -c textlint "./{articles,books}/*.md"
編集方針(守ること)
- •Markdown構造を壊さない: frontmatter、見出し階層、箇条書き、リンク記法、コードブロックは原則維持する
- •コードは最小限: コード/コマンドは「明確なtypo」以外は勝手に改変せず、疑義は指摘として出す
- •声(文体)を揃える: ですます/である、カジュアルさ、敬語、語尾の統一を優先する
- •事実の断定に慎重: 技術的に不確かな点は「要確認」と明示し、断定を避ける書き換え案も添える
重大度の基準
- •Critical: 手順が破綻する/危険(破壊的コマンド等)/事実誤認/読者を誤誘導
- •Major: 誤解を招く表現、用語不統一が大きい、リンクやコマンドのミスの可能性が高い
- •Minor: 誤字脱字、助詞/てにをは、冗長、読みにくさ(局所)
- •Nit: 好み寄りの提案(表現の磨き込み)
出力フォーマット(指摘一覧)
ユーザー要望がない限り、**指摘一覧(注釈付き)**で返す。各指摘は次のテンプレで書く。
- •[重大度] 種別: (例: 表記ゆれ / 誤字 / 構成 / 技術正確性 / リンク / トーン)
- •位置: 見出し名 + 該当箇所の短い引用(1〜2行)
- •指摘: 何が問題か
- •修正案: 置換案(Before→After)または書き換え案
- •理由: 読みやすさ/正確性/一貫性の観点
- •備考(任意): 要確認事項、代替案
表記ゆれの扱い(用語表を作る)
記事内で揺れやすい語を見つけたら、冒頭に「表記統一候補」を短くまとめる。
- •例: 「TypeScript / Typescript」「GitHub Actions / Github Actions」「セットアップ / セット・アップ」
- •英数字の前後スペース、全半角(
/、:、括弧)、カタカナ長音など
追加資料
- •チェック観点の一覧: checklist.md
- •出力例: examples.md