菜单
Load existing code-to-docs vault context into the conversation before coding. Read-only — never writes files. Provides architecture overview, module summaries, known issues, and session history. Use when starting a coding session, loading doc context, or catching up on a documented codebase.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
Install or remove project-level automation hooks for the code-to-docs lifecycle. Setup adds SessionStart (digest on session start) and PostToolUse (update hint after git commits) hooks. Teardown removes only code-to-docs hooks. Use when someone wants to automate doc updates, set up hooks, or remove hooks.
Use when generating documentation from a codebase, creating architecture docs, building an Obsidian vault from code, or when someone asks to document or explain a project's structure
Incrementally update an existing code-to-docs vault after coding changes. Diffs against the last documented commit, re-analyzes only affected modules, merges with existing docs, and tracks issue resolution. Use when someone says update docs, sync docs, refresh documentation, or after making code changes.
基于 SOC 职业分类
| name | digest |
| description | Load existing code-to-docs vault context into the conversation before coding. Read-only — never writes files. Provides architecture overview, module summaries, known issues, and session history. Use when starting a coding session, loading doc context, or catching up on a documented codebase. |
Load structured context from an existing code-to-docs vault. Read-only, never writes files.
| Skill | Purpose |
|---|---|
code-to-docs | Generate full documentation vault from a codebase |
code-to-docs:update | Incremental update — re-analyze only modules with changes since last run |
Skill(skill: "code-to-docs:digest", args: "<vault-path> [--scope <module,...>] [--focus issues|architecture|all]")
<vault-path> — path to existing code-to-docs vault (required)--scope — comma-separated module names to load in full (default: overview only)--focus — architecture (default), issues, or allHaiku — read-and-present task. No analysis or generation required.
Check that <vault-path>/_state/analysis.json exists.
If missing, stop and report:
No code-to-docs vault found at
<vault-path>. Run/code-to-docsto generate one first.
Read:
_state/analysis.json — module inventory, dependency graph, timestampsArchitecture/System Overview.md — architecture narrative and diagrams--focus value | Files loaded |
|---|---|
architecture (default) | Architecture/Dependency Map.md, Architecture/System Map.canvas |
issues | Health/Limitations.md, Health/Code Review.md, Health/Health Summary.md |
all | All architecture + all issues files |
--scope: load full Modules/{Name}.mdOutput a structured summary including:
| Configuration | Target | Action if exceeded |
|---|---|---|
| Default (no flags) | < 3K tokens | Truncate module summaries |
--scope specified | < 6K tokens | Truncate non-scoped modules |
--focus all | < 10K tokens | Truncate oldest session history first |
Do NOT do any of the following:
/code-to-docs:update instead--scope or --focus all — only load overviews by default to stay within token budget