메뉴
Use when mapping source code files to their documentation counterparts — find which docs cover which code, detect gaps, and resolve doc-to-code relationships.
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
| name | mapping |
| description | Use when mapping source code files to their documentation counterparts — find which docs cover which code, detect gaps, and resolve doc-to-code relationships. |
A mapping is a pair: (source_file, doc_file). The audit pipeline resolves all mappings before dispatching to agents. Four strategies are applied in priority order.
User-defined mappings in .claude/docs-guardian/config.json:
{
"mappings": [
{ "source": "src/auth/**/*.ts", "doc": "docs/api/auth.md" },
{ "source": "src/db/models/*.py", "doc": "docs/models/${name}.md" }
]
}
The ${name} placeholder expands to the source file's basename without extension.
Glob patterns are supported in source. The doc field can be a literal path or use ${name}.
Each framework adapter knows its own mapping convention:
| Framework | Convention |
|---|---|
| MkDocs | mkdocs.yml nav entries → doc paths under docs_dir |
| VitePress | .vitepress/config sidebar entries → doc paths |
| Docusaurus | sidebars.js entries → doc paths under docs/ |
| Sphinx | toctree directives → .rst files under source/ |
| Plain Markdown | Convention-based (see Strategy 3) |
When no config or framework mapping exists, use naming conventions:
| Source Path | Doc Path |
|---|---|
src/foo/bar.ts | docs/foo/bar.md |
src/foo/bar.ts | docs/api/foo/bar.md |
lib/foo.py | docs/foo.md |
pkg/foo/bar.go | docs/foo/bar.md |
src/foo/mod.rs | docs/foo.md |
Try each candidate in order. First existing file wins.
If no doc file exists for a source file, record it as unmapped (potential coverage gap).
Some symbols are documented inline (docstrings, JSDoc, godoc comments) rather than in separate doc files. When a source file has no external doc mapping but contains inline documentation:
INFO that docs are inline-only (not necessarily a problem)MEDIUM coverage gapReturn an array of resolved mappings:
[
{
"source": "src/auth/login.ts",
"doc": "docs/api/auth.md",
"strategy": "config",
"confidence": "high"
},
{
"source": "src/utils/hash.ts",
"doc": null,
"strategy": "unmapped",
"confidence": "none"
}
]
Use when generating or auditing documentation in Docusaurus format — covers config, directory structure, frontmatter conventions, and build commands.
Use when generating or auditing documentation in MkDocs format — covers config, directory structure, frontmatter conventions, and build commands.
Use when generating or auditing documentation in plain Markdown format — covers config, directory structure, frontmatter conventions, and build commands.
Use when generating or auditing documentation in Sphinx format — covers config, directory structure, frontmatter conventions, and build commands.
Use when generating or auditing documentation in VitePress format — covers config, directory structure, frontmatter conventions, and build commands.
Use when writing, auditing, or generating documentation for projects in unsupported languages — covers docstring conventions, API doc extraction, and generic heuristic patterns.