with one click
workspace-docs
管理和读取工作区目录文档。使用该技能可了解文件/目录用途、读取 agent 专用备注,或在创建/修改文件后更新文档。
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Menu
管理和读取工作区目录文档。使用该技能可了解文件/目录用途、读取 agent 专用备注,或在创建/修改文件后更新文档。
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
当你需要按用户 prompt 片段从本机 Codex CLI JSONL 会话里定位最近一次相关会话,并导出为可读的 user/assistant Markdown 对话稿时使用。
使用 draw.io CLI 绘制项目架构依赖图,支持中英文标签,导出 SVG/PNG/PDF 预览,并将图片插入 Markdown 文档。
自动工作工具箱入口。用于按需加载架构设计、重构迁移、质量门禁和会话留痕能力;默认只读取本入口,再根据任务打开对应 references 或下游 skill。
管理模块间语义层级依赖关系。注册模块、声明依赖方向、定义接口契约,支持环检测、跨层违规检查和并行开发分组。
用于大规模重构。冻结 old db 作为基线观察,使用 new db 持续建设新结构,并通过 migration_plan.md 管理旧模块到新模块的迁移设计、进度和退出条件。
记录 Agent 会话日志。捕获用户原始 prompt、LLM 理解摘要和执行上下文摘要,用于追溯和复盘。
| name | workspace-docs |
| description | 管理和读取工作区目录文档。使用该技能可了解文件/目录用途、读取 agent 专用备注,或在创建/修改文件后更新文档。 |
这个技能提供了一个基于 SQLite 的工具,用于记录和查询项目中各文件与目录的用途,以及 agent 专用备注。
workspace-docs/workspace_docs.db。docs/workspace_docs.db。WORKSPACE_MAP.md,以避免维护一份重复的 Markdown 总览。所有操作都通过运行 agent_docs.py 脚本完成。
这个技能管理的是“高价值仓库说明”,不是文件系统的全量镜像。
scan 会遵守 .gitignore,默认跳过被忽略的路径。docs/session-logs/、docs/plan/image/、.agent_cache/、runtime/ 这类批量归档或运行时目录,仅维护目录级说明,不要求逐文件写描述。src/、schemas/、技能脚本与关键仓库入口文件。想了解 src/db.py 的作用:
python3 .agents/skills/workspace-docs/scripts/agent_docs.py get "src/db.py"
在创建或修改文件后,记录对应文档信息:
python3 .agents/skills/workspace-docs/scripts/agent_docs.py set "src/new_file.py" -d "Short description" -n "Notes for the Agent"
export 命令仅保留兼容性,不再生成 Markdown 文件:
python3 .agents/skills/workspace-docs/scripts/agent_docs.py export
扫描工作区中未文档化的文件,并将其加入数据库:
python3 .agents/skills/workspace-docs/scripts/agent_docs.py scan
找出按策略应有说明、但仍缺少有效描述的目录和文件:
python3 .agents/skills/workspace-docs/scripts/agent_docs.py audit