shokai 文章校正の手順書
Markdownドキュメントの文章をガイドラインに基づいて校正する。
手順
手順1: 対象ファイルの特定
引数の指定に応じて対象ファイルを決定する。
ファイルパスが指定された場合
指定されたファイルを対象とする。
ブランチの差分を対象にする場合
Bashツールで以下を実行し、変更されたMarkdownファイルを特定する:
git diff --name-only main...HEAD -- '*.md'
対象ファイルが見つからない場合はユーザーに報告して終了する。
引数なしの場合
AskUserQuestionツールで対象ファイルの指定方法を確認する。
手順2: ガイドラインの読み込み
このSKILL.mdと同じディレクトリにある GUIDELINES.md をReadツールで読み込む。
手順3: 違反箇所の検出
対象ファイルを1つずつ読み、ガイドラインの各ルールに照らして違反箇所を検出する。
検出ポリシー
- 意味を変えず自然に改善できる、高確信なもののみ提案する
- 迷う場合はスキップする
除外対象
以下は検出対象外とする:
- code fence内のコード
- inline code
- URL
- frontmatter
- 引用テキスト
- 悪い例として提示されている文章
違反が見つからない場合は「ガイドライン違反は見つかりませんでした」と報告して終了する。
手順4: 修正案の提示と確認
違反箇所ごとにAskUserQuestionツールで修正案を提示する。1違反につき1質問とする。
AskUserQuestionの標準形
- questionにルール番号・名前と該当行を示す
- 修正案をpreviewで表示する
- 修正手法が複数ある場合は選択肢を分ける
- 最後の選択肢は常に「スキップ」にする
ユーザーが修正を承認した場合はEditツールで適用する。スキップが選ばれた場合は次の違反箇所に進む。
手順5: 完了報告
全ての違反箇所を処理したら、修正した箇所数と、スキップした箇所数を報告する。