Code To Doc
PassAudited by ClawScan on May 15, 2026.
Overview
This instruction-only skill is coherently focused on reading project code and documentation to generate or synchronize docs, with some normal but important local-search, file-write, and persistent-note behaviors to review.
Before installing, be comfortable with an agent reading your project source/docs and writing markdown under docs plus OBSERVATIONS.md. Run it in the correct repository, avoid exposing secrets, and review generated or synchronized documentation before committing.
Findings (4)
Artifact-based informational review of SKILL.md, metadata, install specs, static scan signals, and capability signals. ClawScan does not execute the skill or run runtime probes.
The agent may inspect many local source files and run non-destructive search commands while preparing documentation.
The skill instructs the agent to enumerate local project files and may use shell search scripts such as grep/find to extract routes, strings, models, and permissions.
在根目录执行 `list_dir` 或 `ls` ... 当代码量较大（>50 个文件）时...考虑写脚本
Use it only in the intended project workspace, exclude secret/private directories where appropriate, and review any shell command before execution.
Incorrect code interpretation could lead to multiple documentation edits that look authoritative.
Reverse-sync mode can propagate one code change into updates across project documentation.
每次代码变更后也必须...搜索 `docs/[项目名]` 全文...文档落后于实现 → 立即更新
Ask for a summary and review documentation diffs before committing, especially for inferred or broad changes.
Stale or incorrect entries in OBSERVATIONS.md could affect future documentation reviews or hide recurring issues.
The skill creates a persistent project file whose contents influence later scans and suppress repeated observations.
创建 / 更新 `OBSERVATIONS.md` ... **下次扫描必须读取本文件**，跳过"已忽略"项
Keep OBSERVATIONS.md reviewable, correct stale entries, and avoid treating it as fully authoritative without human review.
If the SVG is rendered in an environment that honors the handler, clicking parts of the diagram could insert a preset prompt.
The SVG coverage map includes an inline click handler that may send a predefined prompt in viewers that support this function.
<g onclick="sendPrompt('BRD/MRD 这两类文档在逆向提取时有哪些难点？')"Treat the SVG as interactive content; render it with event handlers disabled or remove onclick handlers if a passive image is desired.