메뉴
Use when generating or updating package documentation with ClaudeCreateDocumentation or ClaudeUpdateDocumentation. Covers resumption after limits, README structure, document queue ordering, and option usage.
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
Use when locating a function, option, symbol, or "where is X handled/implemented" inside this system's own packages (SourceVault, ClaudeOrchestrator, ClaudeRuntime, NBAccess, claudecode, github) — i.e. the initial narrowing step of a code-investigation task, before reading files. Prefer SourceVault MCP packageapi mining over a broad full-text rg sweep of $packageDirectory. Covers concept-token query discipline, sourcevault_get view=body, freshness (StaleDocs) handling, filters.packages scoping, and the bounded grep fallback.
Manipulate/DynamicModule/Dynamic ベースの一覧パネル (SourceVault ワークフロー一覧・ 保存プロンプト一覧など) が「一瞬フリーズしてから $Aborted」になり中身が出ない事故の 原因と直し方。真因は (1) DynamicModule の body や Dynamic[...] の中身の評価は FE の 評価予算で外部 Abort される (通常セル評価と違い時間切れで $Aborted になる)、 (2) Grid 描画 Dynamic の中で「行ごとに重い全走査関数」を呼ぶと row*N 倍のコストで 予算超過する、の 2 点。重いデータは DynamicModule の外 (公開関数の通常評価) で先に 算出して焼き込み、繰り返し読む registry はキャッシュし、行ごとの重い lookup は NextFire 等の不要フィールド計算を外す。headless で再現しないときは FE だけがロード する副パッケージ (SourceVault_autotrigger 等) の差分を疑う。 Use when a Wolfram panel/palette shows $Aborted (especially after a brief FE freeze) instead of its list/grid, when a DynamicModule/Manipulate UI is slow to render or gets aborted, when adding per-row badges/status cells to a list Grid, or when a UI bug reproduces in the FrontEnd but not in headless wolframscript. 関連 rules: 95 (ScheduledTask 安全)。関連 skill: ui-output-font-customization, wolfram-syntax-pitfalls。
Use when the user reports the SourceVault MCP server (or any SourceVault detached service) is stuck "停止中"/Stopped and clicking the palette toggle does not bring it back, when SourceVaultMCPRunningQ stays False, or when diagnosing detached WL service kernel + Python proxy lifecycle (start/stop/restart/heartbeat/scheduled-task/per-machine runtime) issues in SourceVault_servicemanager.wl. Covers the stale status.json "Running" after a kernel crash trap, the PidAlive gate, runtime file inspection, and immediate recovery.
SourceVault.wl の ingest 済みソース行 (SourceVaultSources / SourceVaultArXiv) の Summary 列を埋める設計 (2026-06-24 実装)。arXiv ソースは ingest 時にアブストラクトを arXiv API から取得し $Language へ翻訳して meta["Summary"] に格納する (iIngestURL フック、 同期/非同期両カバー、TimeConstrained best-effort)。既存ソースは公開 API SourceVaultBackfillArXivSummaries[] で backfill。翻訳は cloud LLM (arXiv は公開なので PL 0.0)、iSVLooksLikeLLMError ゲートで利用制限/エラー本文の保存を防ぐ、失敗時は原文 fallback。 Use when implementing or modifying source-row Summary population, arXiv abstract fetch, ingest-time enrichment, or summary translation in SourceVault. 表示パスを LLM-free に保つ 原則と headless $Language 罠を含む。
Use when generating or editing .wl or .m files, dealing with Unicode escapes, Windows Mathematica encoding issues, Japanese identifiers, or RegularExpression patterns in Wolfram Language.
Use for Wolfram Language / Mathematica coding, editing, notebook output style, package conventions, and overall implementation constraints in this environment. Especially relevant for .wl, .m, and .nb work.
| name | doc-generation |
| description | Use when generating or updating package documentation with ClaudeCreateDocumentation or ClaudeUpdateDocumentation. Covers resumption after limits, README structure, document queue ordering, and option usage. |
GithubRepositories/ 配下のファイルは編集してはならない。
$packageDirectory/GithubRepositories/<パッケージ名>/ に置かれたファイルは、ローカルの <パッケージ名>_info/docs/ との差分を取って GitHub への更新コミットメッセージを作成するためのリファレンスとして保持されている。編集すると差分が失われ、コミットメッセージの作成ワークフローが壊れる。
<パッケージ名>_info/docs/ 以下のファイル（例: ClaudeRuntime_info/docs/api.md）GithubRepositories/ClaudeRuntime/ClaudeRuntime_info/docs/api.md などは編集しないこの制約は、ClaudeUpdateDocumentation による自動生成・ClaudeUpdatePackage によるパッケージ更新・手動でのドキュメント修正、いずれの場合にも適用される。
api.md はパッケージの「唯一の真実のソース」である。 LLM がこのファイルだけを読んで、パッケージの全公開関数を正しく使えるコードを書けなければならない。
api.md はヒトが読むドキュメントではなく、LLM がコード生成に使う参照ファイルである。 以下の原則でトークン消費を最小化しつつ情報密度を最大化する:
--- を使わない: ### 見出しだけで区別する**引数:** などの冗長なラベルは不要NBCellCount[nb] のような単純な関数に例は不要。オプションやパターンが複雑な関数にのみ例を付ける### $VarName
型: Association, 初期値: <|"key" -> value|>
説明文（1行）
### FuncName[arg1, arg2] → ReturnType
説明文（1行）
### FuncName[arg1, arg2, opts]
説明文（1行）
→ ReturnType（構造の説明が必要なら追記）
Options: Opt1 -> Default1 (説明), Opt2 -> Default2 (説明)
### FuncName[arg1, arg2, opts]
説明文
→ <|"Key1" -> ..., "Key2" -> ...|>
Options: Opt1 -> Default1 (説明), Opt2 -> Default2 (説明)
例: FuncName["pkg", "msg", Branch -> "dev", Force -> True]
### FuncName[a] / FuncName[a, b] / FuncName[a, b, c]
パターン別の説明
## カテゴリ名）api.md / api_*.md は 既存ファイルを「更新」する（ソースから完全再生成して上書きしない）。理由: 既存の api doc にはソースコードからは導出できない人手の prose（概要、設計ノート、規約、節の解説、worked example）が含まれており、これらは保全しなければならない。
更新プロンプト（iBuildDocPrompt / iUpdateDocNext）は CURRENT DOCUMENT を含め、LLM に次を指示する:
iSafeWriteDoc のサイズ退行ガードが既存の 40% 未満への縮小を拒否する）。⚠️ 旧方針（「Generate ENTIRELY from source. Do NOT reference any prior version.」＝ソースから完全再生成）は 2026-06-25 に廃止。薄いソースの api doc で curated prose を失い、サイズ退行ガードに弾かれる（あるいは閾値超で気づかず prose を喪失する）ため。「唯一の真実のソース」であることと、ソースから毎回作り直すことは別物——既存 prose を保ちつつソースに同期する。
README.md は必ず最後に生成/更新する。これは絶対的なルールである。
$iDocQueue および ClaudeUpdateDocumentation の処理順序:
README.md はパッケージの概要文書であり、setup.md / user_manual.md / api.md / examples の重要な点のまとめとして機能する。先に生成すると:
コード内では iEnsureReadmeLast ヘルパーが自動的に README.md をリストの末尾に移動する。iGuessTargetDocs の結果にも適用される。
ClaudeUpdateDocumentation 実行時も同じ順序を厳守する:
allDocs は iEnsureReadmeLast で README.md を末尾に移動iGuessTargetDocs の結果に iEnsureReadmeLast を適用README.md は以下の構造をこの順序で持たなければならない:
# パッケージ名 — 設計思想と実装の概要## 詳細説明以下のサブセクションを含む:
## 謝辞（Acknowledgments オプション指定時のみ）## 免責事項（必須）## ライセンス（設定済みの場合、必ず最後）謝辞（Acknowledgments）、免責事項（Disclaimer）、ライセンス（License）は README.md の末尾にのみ存在しなければならない。
## 謝辞（Acknowledgments オプションが非空の場合のみ）## 免責事項（必須）## ライセンス（必須、最後）iDocBuildAcknowledgmentsPrompt[], iDocBuildDisclaimerPrompt[], iDocBuildLicensePrompt[] は README.md 生成時にのみプロンプトに挿入される$iDocKeywords の README.md エントリには謝辞・ライセンス・免責関連キーワードが含まれ、iGuessTargetDocs がこれらの更新指示を README.md のみにルーティングする_documentupdate バックアップからソースコード差分を自動検出するClaudeUpdateDocumentation で複数ドキュメントが更新対象になる場合、各ドキュメントの更新時には指示文の該当部分のみを反映すること:
ClaudeCreateDocumentation / ClaudeUpdateDocumentation の共通オプション:
| オプション | デフォルト | 説明 |
|---|---|---|
Fallback | False | Fallback モデル使用 |
References | {} | 参考文献の URL / 書名リスト → README の「参考文献」セクションに追加 |
Demos | {} | デモ動画・使用例の URL リスト → README の「使用例・デモ」セクションに追加 |
Disclaimer | {} | 免責事項に追記する文言リスト |
Acknowledgments | {} | 謝辞セクションに追加する文言リスト。非空なら README.md の免責事項の前に配置 |
License | "" | ライセンステキスト。空ならMIT自動生成。文字列指定でカスタムライセンス |
TargetFiles | Automatic | 更新対象ファイルを明示指定。Automatic なら指示文から自動判定。{"api.md", "install.md"} 等でファイル限定 |
Mode | "Update" | "Update" = 既存を差分更新、"Create" = 新規作成（既存内容を無視） |
第二引数の指示文中に URL が含まれていれば、自動的に Demos に追加される。
"claude-sonnet-4-20250514" — ドキュメント生成は Sonnet クラスで十分$ClaudeDocModel = "" で $ClaudeModel と同じモデルを使用iBuildChunkedSource によるチャンク化を適用（以前はソース全文を毎回送信していた）iIsNarrowScopeInstruction がライセンス・免責・謝辞のみの更新を検出ClaudeUpdateDocumentation["pkg"] を使用する| ドキュメント | 文体 | 理由 |
|---|---|---|
| api.md | 常体（だ・である調） | 簡潔さを優先するリファレンス文書 |
| setup.md | 敬体（です・ます調） | ユーザー向け説明 |
| user_manual.md | 敬体（です・ます調） | ユーザー向け説明 |
| examples/example.md | 敬体（です・ます調） | ユーザー向け説明 |
| README.md | 敬体（です・ます調） | ユーザー向け概要・紹介 |
注意: $Language の設定に基づいて言語が決定される。日本語以外が設定されている場合はその言語で出力される。
iSafeWriteDoc による保護（いずれかに該当したら書き込まず $Failed＝ファイルは変更しない）:
# タイトル がパッケージ名と一致しない場合は拒否（LLM が別のドキュメント内容を返した場合の防護）iDocLooksTruncated): 応答が途中で切れた場合を検出して拒否。サイズ 40% ガードを通過しても壊れるため必須。確実な兆候のみ: ①未閉じコードフェンス（``` が奇数）②文・構文の途中で終端（末尾が読点 、/，/, や開き括弧 (/（/「）。途中失敗で「壊れたまま続行」「再実行で更新済みファイルまで再生成」する事故を防ぐため、ClaudeUpdateDocumentation の更新チェーン（iUpdateDocNext）は次のように動く:
iIsAPIErrorResponse）、またはiSafeWriteDoc が $Failed）
のいずれかなら、そのファイルを書かず、残りのファイルにも進まずチェーン全体を中断する。以前は品質失敗を skip して次へ進み、エラーが出ても更新を続けていた（これがバグ）。中断時もそれまでに成功したファイルは保全される。iDocCycleKey で識別され、成功したファイルは <docsDir>/.docupdate_progress.json に記録される。中断後に同じソース状態で再実行すると、更新済みファイルをスキップして残りから再開する。サイクル完全完了時に進捗ファイルはクリアされる（次回はソース変更で新サイクル）。ソースを編集すれば cycleKey が変わり全ファイル再生成。SourceVault のように README 以外が閾値 $iDocParallelThreshold（既定 5）以上 になる更新では、ClaudeUpdateDocumentation は逐次チェーン（iUpdateDocNext）でなく 並列コーディネータ iUpdateDocsParallel に振り分け、各 doc の LLM 呼び出しを並列投入する。
iBuildDocPrompt[sourceCode, pkg, docsDir, docFile, instruction, diffText, mode, designContext, splitCache] が組み立てる（逐次・並列で共有。README は兄弟 doc をディスクから読むため、呼ぶ前に兄弟が書き込まれている必要がある）。$LLMGraphMaxConcurrency["cli"]（既定 3）。iClaudeQueryAsyncWithProgress（claudecode 共有ポーリング）にファンアウトするので rule 95 準拠（独自 ScheduledTask を作らない）。iUpdateDocNext。iIsAPIErrorResponse でレスポンスをチェックする。rules/90-api-error-handling.md を参照。License -> "" (デフォルト) かつ GitHubREST$GitHubLicenseHolder` が非空文字列の場合:
MIT ライセンスが README.md の最後（免責事項の後）に自動挿入される。License -> "カスタムテキスト": 指定テキストがそのままライセンスセクションに挿入される。$GitHubLicenseHolder が空文字列の場合: ライセンスは挿入されず、警告が Print される。$Path のルール.wl パッケージは $packageDirectory 直下に配置される$Path に追加するのは $packageDirectory 自体AppendTo[$Path, $packageDirectory]AppendTo[$Path, "C:\\path\\to\\PackageName"]Block[{$CharacterEncoding = "UTF-8"},
Needs["PackageName`", "PackageName.wl"]];
iIsDocLimitError でリミットメッセージを判定呼び出し時に iCheckDocResumption で以下を判定:
Documentation` パッケージは以下の特殊セルスタイルを提供する。これらは「メタセル」と呼ばれ、エクスポート時に出力から除外され、展開・翻訳・同期の対象にもならない。
"Note""Dictionary"{{<<Japanese>>, <<English>>, <<Context>>}, {"状相", "configuration", "セルオートマトン"}, ...}<<>> で囲む）、2行目以降が「Context の文脈における用語対応」を表す=== Dictionary === ブロックとして自動注入され、翻訳時に用語の対応を強制する"Directive"=== Directives === ブロックとして自動注入される展開・翻訳・同期の各操作時、LLM プロンプトには以下が順に挿入される:
iDocCollectDirectives[nb] — 全 Directive セルの内容iDocCollectDictionary[nb] — 全 Dictionary セルの用語対応iDocCollectContext[nb, cellIdx] — 周辺セルのテキストとアタッチメント情報$iDocTagExcludeExport タグを付けて、エクスポートから除外できる× が表示されるDocSplitCell)$NBLLMQueryFunc で前半・後半用に再生成PrivacyLevel に基づき $ClaudePrivateModel にルーティングされるDocMergeCells)"Bibliography"{{<<Key>>, <<Author>>, <<Year>>, <<Title>>}, {"morita1996", "K. Morita", "1996", "Universality of..."}}\begin{thebibliography}...\end{thebibliography}、Markdown では ## References セクションとして自動出力<<cite:key>> が \cite{key} / [Author, Year](#ref-key) に自動変換DocEditFigureMeta)figLabel（参照用ラベル）と figCaption（キャプション）を保存\begin{figure}[h]\centerline{\includegraphics[scale=.8]{...}}\caption{...}\label{fig:...}\end{figure} を出力iDocBuildFigureTable で Export 時にセル順で自動付番<<fig:label>> → 図参照（LaTeX: \figurename~\ref{fig:label}, Markdown: [Figure N](#fig-label)）<<cite:key>> → 引用（LaTeX: \cite{key}, Markdown: [Author, Year](#ref-key)）iDocResolveReferences で Export 時に全テキストセルに適用$iDocTagCleanText — プログラムが書き込んだテキストのクリーンコピーを TaggingRules に保存iDocWriteAndTrack[nb, cellIdx, text] — テキスト書き込み + クリーンコピー記録の一括ヘルパーcleanText と現在テキストを比較し、不一致なら編集ありと判定iDocPostToggleSync がバックグラウンドで発動:
iDocReTranslatePromptFn）iDocReExpandPromptFn）iDocReverseSyncPromptFn）PrivacyLevel 対応で秘匿セルは $ClaudePrivateModel にルーティング{Subsection -> Section, Subsubsection -> Subsection} のような Wolfram Language のルール式を記述すると、Markdown/LaTeX エクスポート時にセルスタイルが読み替えられるiDocParseStyleRemap[nb] が全 Directive セルを走査し、{...->...} パターンを抽出して <|"Subsection" -> "Section", ...|> の Association を構築iDocTextCellToExport の冒頭で style = Lookup[styleRemap, style, style] を適用Subsection）も文字列（"Subsection"）も自動的に文字列に変換される$iDocTagCleanMode — テキスト書き込み時のモード状態を "paragraph:False" のような文字列で記録wasEdited チェック時に cleanMode === currentMode を検証。モードが変わっていれば cleanText は前モードの残留値として無視されるiDocShowAllAs（一括表示切替）の全書き込み箇所に $iDocTagCleanText 追跡を追加DocTranslate のキャッシュ表示パス（LLM 不要の即時表示）にも追跡を追加StringQ[cleanMode] = False → wasEdited = False となり安全DocExportMarkdown で Markdown を生成し、Pandoc で .docx に変換ProcessDirectory -> outDir で Pandoc を画像フォルダ内で実行し、相対パスの画像を確実に解決--from=markdown+implicit_figures で {#label} を図として認識"ReferenceDoc" -> "template.docx" でスタイルテンプレートを指定可能iDocDetectExportLanguage[nb] — 翻訳表示セルが過半数なら翻訳ターゲット言語を返すiDocTranslateBibTitle が日本語タイトルを検出し、PDF テキストから英語タイトルを探すか LLM で翻訳iDocTranslateFigCaption がターゲット言語に翻訳exportLang パラメータが iDocCellToExport → iDocOutputCellToExport → bib 出力まで一貫して伝搬