mcpField
R
research-guide-updater

research-guide-updater

github.com/huangwb8ドキュメント3.0k39 回インストール2 週間前に更新
リポジトリ

research-guide-updater について

research-guide-updaterは、会話で得た再利用可能な執筆上の知見をプロジェクトガイドに段階的に反映するスキルです。研究文書の管理者向けで、入力処理、配置、検証、復旧を定め、ガイドファイルのパス指定を求めます。

主な機能

  1. 01発言を原子的な要点に分解
  2. 02既存の節から配置先を選択
  3. 03差分パッチでガイドを更新
  4. 04構成を検証しエラーの証拠を保持
  5. 05作業ファイルと成果物を管理

活用シーン

  1. 01研究執筆の規則をガイドファイルに同期
  2. 02既存構成内に用語や方法の規則を追加
  3. 03ガイド更新を検証し失敗箇所から再開

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/huangwb8/chineseresearchlatex --skill research-guide-updater

インストール後、Claude Code で/research-guide-updaterを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

CHANGELOG.md
config.yaml
README.md
references/
guide-structure-map.md
scripts/
validate_guide.py

詳細

プロジェクトガイド更新ツール

前提条件

更新のたびに、事前に簡単なセルフチェックを行います。

  • 新たな ## レベルの見出しを追加しません。新しい要点は、既存の小見出しやリストに「溶け込ませる」形で追加します。
  • 既存の見出しテキスト、番号、順序を変更しません。「見栄えを整える」目的で大量の内容を並べ替えません。
  • 追加内容は、原則として1つまたは少数の箇条書きとし、隣接する項目の書き方や語調に合わせます。
  • 事実や文献に関する内容は、検証可能な情報のみを記載します。検証できない場合は「要検証」と明記し、詳細を捏造しません。

ワークフロー

入力

ユーザーの依頼と設定ファイルに基づいて必要な入力を用意します。不足する情報があれば明示し、その入力に依存する手順を停止します。

実行手順
  • ユーザー環境で、このスキルの設計上の欠陥が原因のバグが発生した場合は、規定に従って bensz-collect-bugs を優先的に使用し、~/.bensz-skills/bugs/ に記録します。ユーザーのローカル環境にインストール済みの Claude Code / Codex のスキルソースを直接変更することは厳禁です。
  • AI が回避策を使ってユーザーのタスクを続行できる場合は、まずバグを記録してから、現在のタスクを完了します。
  • ユーザーが「report bensz skills bugs」など、公開報告を明示的に求めた場合は、ローカルの gh と bensz-collect-bugs を呼び出し、新たなバグのみを huangwb8/bensz-bugs にアップロードします。バグリポジトリ全体を pull / clone しないでください。

会話で新たに得られた再利用可能な執筆上の知見を、用語の一貫性、構造の安定性、検証可能性、再現性を保ちながら、プロジェクトガイドファイルにリアルタイムで反映します。

旧名の guide-updater は、prompt との互換性を保つための別名としてのみ残します。新バージョンのインストール時に、システムレベルの旧ディレクトリは削除されます。

このスキルを呼び出す際は、必ず引数にガイドファイルのパスを指定してください。

/research-guide-updater --guide-path <路径>

自然言語での指定例:

  • 「プロジェクトガイドを更新(パス:projects/MyProject/プロジェクトガイド.md)」

  • 「この内容をガイドファイル docs/執筆ガイド.md に反映」

  • ユーザーの表現を、実際に文章化できる要点に分解します。各要点には、主張またはルール、書き方を1つだけ含めます。

  • 各要点に、ガイドに記載する目的を1文で付記します(例:用語の統一/査読での疑義防止/再現性の確保/リスク管理)。

  • より詳細な配置ルールが必要な場合は、作業前に skills/research-guide-updater/references/guide-structure-map.md を読んでください。

  • 執筆原則/禁止事項/文型 → ## 執筆哲学

  • 用語、略語、大文字・小文字、主要概念の定義 → ## 命名と用語

  • 手法の流れ、検証基準、評価指標 → ## 基本原理

  • パラダイムの位置づけ、比較の基準軸、差別化の要点 → ## 文献レビューと独自性

  • 具体的な記載先(文書構成との対応) → ## 配置一覧

  • 査読者からの質問への回答方針 → ## 査読者が想定する質問と回答

  • リスクと対策 → ## 研究リスク

  • 「検証可能な事実の根拠」(ソースコード、パラメーター、手順) → ## 付録

配置先が不明な場合は、今後の執筆の手戻りを最も減らせる箇所を優先します。それでも不明な場合は、ファイルを編集する前にユーザーへ「執筆哲学/技術方針/リスク管理のどれに分類して記載しますか?」と確認します。

  • 変更は「差分パッチ」のみに限定します。箇条書きを1~3件追加するか、既存の箇条書きの末尾に説明を1文補います。
  • 長文の新しいセクションは作成しません。大きな知見は、複数の箇条書きに分けて、該当する小節に分散して記載します。
  • 既存の用語と統一します(プロジェクト既存の用語集を参照)。
ディレクトリ用途
scripts/项目指南.md が重要な構造と必須見出しを維持しているか検証します
references/構造のマッピングと配置ルールを記録し、配置場所を何度も判断することを防ぎます
出力

Skill description で約束されている成果物を出力し、形式、パス、失敗時の返却形式を明示します。

出力管理

この Skill の新しいタスクで使用する中間ファイルは、すべて ./.bensz-api/task-{yyyymmdd-hhmm}-{簡短描述}/{skill名}/input|output|log/ に保存します。同じタスクでは1つのタスクルートディレクトリを再利用し、複数の Skill が連携する場合にのみ shared/ を作成します。正式な成果物はこのディレクトリに保存しません。過去の隠しディレクトリは、明示的な互換読み取り、移行、またはクリーンアップの場合に限り使用できます。

検証
  • python skills/research-guide-updater/scripts/validate_guide.py <指南文件路径> を実行します(または、重要な ## 見出しが維持されていることを手動で確認します)。
  • 意図せず ## レベルの見出しが追加されていないか、または「新たに作り直した」構造が導入されていないかを検索します。
失敗と復旧

エラーの証跡と完了済みの成果物を保持します。入力、環境、または外部依存関係が復旧した後に限り、直近の失敗手順から再試行します。

制約

以下の共通制約を遵守し、この Skill 固有の境界も守ります。

共通の厳格な制約
  • タスクでファイルへの保存が必要な場合は、一意の ./.bensz-api/task-{yyyymmdd-hhmm}-{简短描述}/ ルートディレクトリを使用します。共有資料は shared/ に、Skill 固有の資料はその Skill の input/、output/、log/ に保存します。
  • 正式な成果物、ソースコード、正式な計画はプロジェクトの規約に従って保存し、タスク作業領域には保存しません。許可なく上書き、削除、移行、リモートへの書き込みを行いません。
  • プロジェクトのメンテナンス変更では BAC の利用可否を確認し、要件、AI の出力、ツールの結果、ファイルの変更、検証の概要を記録します。BAC はプロセスの監査のみを行い、著者の明示、責任、コンプライアンスに関する判断に代わるものではありません。
  • API Key、アクセス トークン、パスワード、Cookie、環境/認証情報ファイル、非公開 Prompt、個人情報、ローカルのユーザー名、ホスト名、不要な大容量の生データを記録しません。
  • ファイルパスを正規化し、許可されたプロジェクトの範囲内に制限します。外部 URL、サブプロセス、ネットワークアクセスには最小権限の原則を適用し、パストラバーサル、SSRF、コマンドインジェクションを防止します。
  • Skill のバージョンは、その Skill 自身の config.yaml:skill_info.version にのみ記録します。公開 API、プロトコル、ディレクトリ、設定の変更は、ドキュメントと CHANGELOG.md にも反映します。
  • bensz-collect-bugs に報告するのは、Skill または Bensz インフラストラクチャ自体の設計上の欠陥に限ります。機微情報を除去してから ~/.bensz-skills/bugs/ に記録し、現在のタスクは中断しません。公開報告はユーザーが明示的に求めた場合に限り行い、ユーザーがインストール済みの Skill ソースを直接変更することは禁止します。
Skill 固有の制約

この Skill description と上記のワークフローで定められた範囲を超えてはなりません。未検証の情報を、確定した結論であるかのように扱ってはなりません。

コメント