mcpField
T
tutor-setup

tutor-setup

github.com/bevibing生産性1.4k2.0k 回インストール35 週間前に更新
リポジトリ

tutor-setup について

tutor-setupは、文書やコードベースをObsidianのStudyVaultにまとめます。作業ディレクトリに応じて処理モードを選び、ノート、練習問題、相互リンクを作成します。

主な機能

  1. 01文書・コードベースモードの判定
  2. 02作業ディレクトリ内の資料の検索
  3. 03トピックノートと練習問題の作成
  4. 04ノート間の相互リンク
  5. 05品質チェックリストによる確認

活用シーン

  1. 01PDFやテキスト資料の学習ノート化
  2. 02コードベースのオンボーディング資料作成
  3. 03トピック別練習問題と復習ダッシュボードの作成

インストール

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

$npx skills add https://github.com/bevibing/tutor-skills --skill tutor-setup

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

同梱ファイル

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

references/
codebase-templates.md
codebase-workflow.md
quality-checklist.md
templates.md

詳細

チューターのセットアップ — Knowledge to Obsidian StudyVault

CWD 境界ルール(すべてのモード)

現在の作業ディレクトリ(CWD)の外にあるファイルには、絶対にアクセスしないでください。 ソースのスキャン、読み取り、Vault への出力は、すべて CWD とそのサブディレクトリ内で行う必要があります。 ユーザーが外部のパスを指定した場合は、まずファイルを CWD にコピーするよう依頼してください。

モードの検出

呼び出されたときに、モードを自動的に検出します。

  1. CWD 内のプロジェクトマーカーを確認します。
    • package.json、pom.xml、build.gradle、Cargo.toml、go.mod、Makefile、 *.sln、pyproject.toml、setup.py、Gemfile
  2. マーカーが見つかった場合 → コードベースモード
  3. マーカーが見つからない場合 → ドキュメントモード
  4. 判定が分かれる場合:.git/ だけが判断材料で、ソースコードファイル(*.ts、*.py、*.java、*.go、*.rs など)が存在しない場合は、デフォルトでドキュメントモードにします。
  5. 検出したモードを伝え、ユーザーに確認または変更を求めます。

ドキュメントモード

ナレッジソース(PDF、テキスト、ウェブ、epub)を学習ノートに変換します。 テンプレート:templates.md

フェーズ D1:ソースの検出と抽出
  1. CWD 内を自動スキャンして **/*.pdf、**/*.txt、**/*.md、**/*.html、**/*.epub を検索します(node_modules/、.git/、dist/、build/、StudyVault/ は除外)。ユーザーに提示し、確認を求めます。
  2. テキストの抽出(指定ツール必須):
    • PDF → pdftotext CLI のみ(Bash ツールで実行)。PDF ファイルを Read ツールで直接読み取ることは絶対にしないでください。ページが画像としてレンダリングされ、トークンを 10~50 倍無駄に消費します。まず .txt に変換してから、その .txt ファイルを Read で読み取ります。
      pdftotext "source.pdf" "/tmp/source.txt"
      
    • pdftotext がインストールされていない場合は、先に brew install poppler(macOS)または apt-get install poppler-utils(Linux)でインストールします。
    • URL → WebFetch
    • その他の形式(.md、.txt、.html)→ 直接 Read で読み取ります。
  3. 抽出した .txt ファイルを読み取り、範囲、構成、内容の深さを把握します。変換後のテキストのみを使用し、元の PDF は決して参照しないでください。
  4. ソース内容のマッピング(複数ファイルのソースで必須):
    • ソースファイルごとに、表紙+目次+中盤/終盤のサンプルページ 3 ページ以上を読み取ります。
    • ファイル名から内容を推測しないでください。ファイルの番号と章番号が一致しないことはよくあります。
    • 検証済みのマッピングを作成します:{ source_file → actual_topics → page_ranges }
    • 学術資料ではないファイルや不足しているソースに印を付けます。
    • 作業を進める前にマッピングをユーザーに提示し、確認を求めます。
フェーズ D2:内容の分析
  1. トピックの階層(セクション、章、分野区分)を特定します。
  2. 概念の説明と演習問題を区別します。
  3. トピック間の依存関係をマッピングします。
  4. 比較、決定木、数式など、重要なパターンを特定します。
  5. トピックの完全なチェックリスト(必須) — すべてのトピックとサブトピックを列挙します。以降のすべてのフェーズの指針になります。

深さを均等にするルール:簡単に触れられているだけのサブトピックにも、教科書レベルの知識で補足した専用ノートを必ず作成します。

  1. 分類の網羅性:「X の 3 種類」のようにソースでカテゴリが列挙されている場合、各項目に専用ノートを作成します。「types of」、「N가지」、「categories」、「there are N」を検索します。
  2. ソースとノートの相互検証(必須):各トピックを扱うソースファイルとページ範囲を記録します。追跡できないトピックには「source not available」と印を付けます。
フェーズ D3:タグ標準

ノートを作成する前に、タグの語彙を定義します。

  • 形式:英語、小文字、ケバブケース(例:#data-hazard)
  • 階層:最上位 → 分野 → 詳細 → 手法 → ノート種別
  • 登録簿:登録済みのタグのみ使用できます。詳細タグには、親となる分野タグを併記します。
フェーズ D4:Vault の構成

templates.md に従って番号付きフォルダーを作成し、その中に StudyVault/ を作成します。関連する概念を 3~5 個ずつ、ファイルごとにまとめます。

フェーズ D5:ダッシュボードの作成

00-Dashboard/ を作成します:MOC、クイックリファレンス、試験のひっかけ問題。templates.md を参照してください。

  • MOC:トピックマップ + 練習ノート + 学習ツール + タグインデックス(ルール付き) + 苦手分野(リンク付き) + 中核以外のトピックに関する方針
  • クイックリファレンス:すべての見出しに → [[Concept Note]] リンクを含めます。すべての重要な公式を記載します
  • 試験のひっかけ問題:トピックごとのひっかけポイントを折りたたみコールアウトに記載し、コンセプトノートにリンクします
フェーズ D6:コンセプトノート

templates.md に従ってください。主なルール:

  • YAML フロントマター:source_pdf、part、keywords(必須)
  • source_pdf は、検証済みのフェーズ D1 の対応付けと必ず一致させてください。ファイル名から推測しないでください
  • 利用できない場合:source_pdf: 원문 미보유
  • [[wiki-links]]、コールアウト([!tip]、[!important]、[!warning])、文章よりも比較表を優先します
  • プロセス/フロー/シーケンスには ASCII 図を使用します
  • 例外を含めて簡略化:一般的な記述には、エッジケースについての注記を含める必要があります
フェーズ D7:練習問題

templates.md に従ってください。主なルール:

  • すべてのトピックフォルダーに練習問題ファイルを必ず用意します(8 問以上)
  • アクティブリコール:回答には > [!answer]- 정답 보기 折りたたみコールアウトを使用します
  • パターンには > [!hint]- / > [!summary]- 折りたたみコールアウトを使用します
  • 問題形式の多様性:ファイルごとに、想起問題を 60%以上、応用問題を 20%以上、分析問題を 2 問以上含めます
  • ## Related Concepts に [[wiki-links]] を記載します
フェーズ D8:相互リンク
  1. すべてのコンセプトノートに ## Related Notes を記載します
  2. MOC からすべてのコンセプトノートと練習ノートにリンクします
  3. コンセプトノートと練習ノートを相互にリンクします。兄弟ノート同士も相互参照します
  4. クイックリファレンスの各セクションから [[Concept Note]] にリンクします
  5. 苦手分野から関連ノートと試験のひっかけ問題にリンクします。試験のひっかけ問題からコンセプトノートにリンクします
フェーズ D9:セルフレビュー(必須)

quality-checklist.md の ドキュメントモード セクションに照らして確認します。すべてのチェックに合格するまで、修正と再確認を繰り返します。


コードベースモード

ソースコードプロジェクトから、新規開発者向けのオンボーディング用 StudyVault を生成します。 ワークフロー全体:codebase-workflow.md テンプレート:codebase-templates.md

フェーズの概要
フェーズ名前主なアクション
C1プロジェクトの調査ファイルをスキャンし、技術スタックを検出し、エントリーポイントを読み、ディレクトリ構成を把握します
C2アーキテクチャ分析パターンを特定し、リクエストの流れを追跡し、モジュールの境界とデータフローを把握します
C3タグ標準#arch-*、#module-*、#pattern-*、#api-* タグのレジストリを定義します
C4Vault の構成ダッシュボード、アーキテクチャ、モジュールごとのフォルダー、DevOps、演習のフォルダーを含む StudyVault/ を作成します
C5ダッシュボードMOC(モジュールマップ + API の概要 + 導入ガイド + オンボーディングの手順) + クイックリファレンス
C6モジュールノートモジュールごとのノート:目的、主要ファイル、パブリックインターフェイス、内部フロー、依存関係
C7オンボーディング演習コード読解、設定、デバッグ、拡張の演習(主要モジュールごとに 5 問以上)
C8相互リンクモジュール間、アーキテクチャと実装間、演習とモジュール間を相互にリンクします
C9セルフレビューquality-checklist.md の コードベースモード セクションに照らして確認します

各フェーズの詳しい手順については、codebase-workflow.md を参照してください。


言語

  • ソース資料と同じ言語にします(韓国語 → 韓国語のノートなど)
  • タグ/キーワード:必ず英語にします

コメント