ja-writing
日本語の文章を、textlintによる機械的な検査と、文章を書いた経緯を知らない別のエージェントによるレビューの2段階で確認する。 次のときに使う。 (1) README・ドキュメント・コードコメント等の日本語の文章を書いたとき。 (2) コミットメッセージ・Issue・Pull Requestの本文を日本語で書いたとき。 (3) 日本語で書かれた既存の文章のレビューを依頼されたとき。 (4) textlintで日本語の文書を検査・修正するとき。 textlintの実行と結果への対応、AIレビューの依頼方法、誤検出の抑制方法を扱う。
- License 许可
- MIT
- 最近更新
- 2026-11-14
- Stars
- ★ 0
- Forks
- 0
01 前言 Front Matter
- name
- ja-writing
- description
- 日本語の文章を、textlintによる機械的な検査と、文章を書いた経緯を知らない別のエージェントによるレビューの2段階で確認する。 次のときに使う。 (1) README・ドキュメント・コードコメント等の日本語の文章を書いたとき。 (2) コミットメッセージ・Issue・Pull Requestの本文を日本語で書いたとき。 (3) 日本語で書かれた既存の文章のレビューを依頼されたとき。 (4) textlintで日本語の文書を検査・修正するとき。 textlintの実行と結果への対応、AIレビューの依頼方法、誤検出の抑制方法を扱う。
- compatibility
- Required: bun >= 1.2
02 资源文件 7
- 其他.gitignore14 B
- 参考文档.prh.yaml12.4 KB
- 参考文档.textlintrc.fix.json1.0 KB
- 参考文档.textlintrc.json1.1 KB
- 其他bun.lock108.2 KB
- 参考文档package.json1.1 KB
- 参考文档references/review-prompt.md27.4 KB
03 SKILL.md 正文
日本語の文章の確認
日本語の文章を、次の2段階で確認する。
- 文章が、表記・文の長さ・禁止語等の機械的に判定できる規則に違反していないかを、textlintで検査する
- 文章を書いた経緯・意図を知らない別のエージェント(以下、レビューするエージェント)に、textlintで判定できない規則に従って文章をレビューさせる(以下、AIレビュー)
準備
bunが無い場合は作業を止めてユーザーに確認する。
このSKILL.mdがあるディレクトリで、ロックファイルどおりに依存パッケージをインストールする。 このインストールはgitで管理しているファイルを変更しないため、ユーザーの確認を取らずに実行してよい。
bun install --frozen-lockfile --production
手順
1. 検査対象の文章をファイルに書き出す
textlintとAIレビューはどちらもファイルを対象にする。 リポジトリの規約に一時ファイルを置くディレクトリの定めが無い場合はそのディレクトリをユーザーに確認する。 コミットメッセージ・Issue・Pull Requestの本文のようにファイルが無い文章は、作業中のリポジトリで一時ファイルを置くディレクトリにMarkdownファイルとして書き出す。
対応する拡張子(@cffnpwr/textlint-plugin-comments)のソースコード・設定ファイルはtextlintがコメントの部分だけを検査する。 対応していない拡張子のファイルのコメントはMarkdownファイルに書き出して検査する。
2. textlintで検査する
次のコマンドはこのSKILL.mdがあるディレクトリで実行する。
作業中のリポジトリに独自のtextlint設定(.textlintrc・.textlintrc.json等)がある場合は、2つのコマンドの--configの値をその設定ファイルの絶対パスに置き換える。
# ファイルを検査する
bun x textlint --config .textlintrc.json /absolute/path/to/file.md
# 自動修正できるエラーを修正する
bun x textlint --fix --config .textlintrc.fix.json /absolute/path/to/file.md
自動修正ではprhを除いた設定(.textlintrc.fix.json)を使う。
.prh.yamlの規則の多くは置換後の語が1つに定まらないため、自動修正すると文が壊れる。
prhの指摘は指摘メッセージに表示される指示に従って手で直す。
errorは修正するwarningは、指摘された問題が実際に文章にあると判断した場合に修正する。修正しない場合は理由をユーザーに伝える
指摘を直すときは前後の文とのつながりを保つ。 文を分割すると前の文との関係を示す語が無くなり、読み手は2つの文の関係(理由・対比・条件)を補えなくなる。 次の方法は文化審議会「公用文作成の考え方」p.32〜33の例文に基づく。
- 文を分割した場合は後の文の冒頭に前の文との関係を示す接続詞・指示語(「このうち」「そのため」等)を補う
- 分割した後の文にも主語・対象を書く
- 理由・条件を表す節を独立した文にした場合は、その文をそれが支える文の直前に置く
- 接続詞・指示語で始まる文の前に別の文を挿入した場合は、接続詞・指示語の受ける内容が直前の文にあるかを確認する
3. AIレビューを依頼する
textlintのエラーを修正した後、レビューするエージェントに文章をレビューさせる。 サブエージェントを使えるハーネスではサブエージェントにレビューさせる。 サブエージェントを使えない場合は新しいセッションでのレビューをユーザーに依頼する。 依頼するときはそのセッションのエージェントに渡すパスと指示(この節の後半に示す)もユーザーに伝える。 レビューするエージェントのモデルにはClaude Haiku・GPT-6 Luna等の軽量モデルを指定する。
レビューするエージェントに渡す情報は次の2つのパスと、この節の最後に書いた指示だけにする。 文章を書いたエージェント自身がレビューすると、書いた意図を知っているため、読み手が補えない省略を見落としやすいためである。 文章を書いた経緯・意図・直前の会話は含めない。
- 検査対象のファイルのパス
- references/review-prompt.mdのパス
レビューするエージェントには次の2点を指示する。
references/review-prompt.mdの規則に従って、検査対象のファイルをレビューすることreferences/review-prompt.mdの「出力」の節が定める形式に従って、結果を返すこと
検査対象がソースコード・設定ファイルの場合はコメントの部分だけをレビューすることも指示する。
4. 指摘に対応する
AIレビューで指摘された箇所を修正した後、textlintで再び検査する。 textlintの指摘を直して文を変更した場合は、変更した文とその前後の文だけを対象に、AIレビューを再び依頼する。 対象を限るのは変更していない文にも新しい指摘が付き、文章の内容が少しずつ変わることを防ぐためである。 再レビューの依頼では手順3の2つのパスと指示に加えて、対象の行の範囲を渡す。 そのうえで、その範囲の文だけを指摘するよう指示する。 再レビューの指摘を直した場合もtextlintでの検査から同じ手順を繰り返す。 AIレビューの指摘が誤りだと判断した場合は修正せずに、その指摘の内容と、誤りだと判断した理由をユーザーに伝える。
誤検出の抑制
textlintが妥当な内容(固有名詞・コード中の用語・意図した書き方)をエラーとして報告した場合は抑制コメントを使う。 抑制コメントを追加する前に、該当する箇所・規則名・誤検出と判断した理由をユーザーに示し、許可を得る。
<!-- textlint-disable rule-name -->
誤検出された内容。
<!-- textlint-enable rule-name -->
1行だけを対象にする場合は次のように書く。
対象の行。 <!-- textlint-disable-line rule-name -->
規則に合わせるためだけに、意味の変わる言い換えをしない。
04 同仓库更多 Skills
writing-for-agents
Writing documents for agents. Use when creating or editing skills, or modifying AGENTS.md or CLAUDE.md.
wrangler
Run or troubleshoot Wrangler CLI commands in projects that have a wrangler.jsonc, wrangler.json, or wrangler.toml file, including local development, Previews, deployment, and resource management. For new projects and projects without a Wrangler configuration file, use the cf CLI instead.
workflow-modernize
パッケージ/CLI更新時や定期見直し時に、自作スキル・ワークフロー・設定を監査し、不要なworkaroundの撤廃・新機能の適用・プロンプトの簡素化をGrill(壁打ち)と多角比較で提案・修正する。「workflow-modernize」「スキル監査」「ワークフロー改善」「パッケージ更新後の見直し」「モダナイズ」で起動。
workers-best-practices
Cloudflare Workers best practices for production applications. Use when writing, reviewing, or configuring Workers.
web-perf
Audit, diagnose, or optimize website loading and interaction performance, Core Web Vitals, and Lighthouse performance scores.
wayfinder
Plan a huge chunk of work (more than one agent session can hold) as a shared map of decision tickets on your issue tracker, and resolve them one at a time until the way to the destination is clear.