Stats
Actions
Tags
From t-tools
Scans a codebase to extract architecture, APIs, config, and deployment details, then writes structured tutorial documentation under docs/tutorials/ that reads like a human wrote it.
How this skill is triggered — by the user, by Claude, or both
Slash command
/t-tools:t-doc [项目或模块名][项目或模块名]This skill is limited to the following tools:
The summary Claude sees in its skill listing — used to decide when to auto-load this skill
扫描代码库，提取架构、API、配置、部署等信息，写给新人能读懂的项目教程。文档要像工程师写的，不像自动生成的 API 文档。
扫描代码库，提取架构、API、配置、部署等信息，写给新人能读懂的项目教程。文档要像工程师写的，不像自动生成的 API 文档。
/t-doc [名称]不要用于 PRD、技术设计、纯 API schema 自动生成，或只改某个文档小段落的任务。
命令格式：
/t-doc [项目或模块名]
名称 必填，1-50 字符，只允许英文、数字、连字符、下划线。不合法就终止，并提示：
请提供合法的名称。例如：/t-doc my-project
输出语言跟随用户输入；用户没明确指定时默认中文。
目标目录是 docs/tutorials/。如果目录已存在，先告诉用户已有内容，询问覆盖还是增量更新。
动笔前先扫描项目。优先看这些来源：
| 来源 | 关注点 |
|---|---|
README.md, CLAUDE.md | 项目定位、技术栈、运行方式 |
package.json, Cargo.toml, pyproject.toml | 依赖和版本 |
src/, app/, lib/ 入口文件 | 模块结构、路由、核心抽象 |
docs/, guides/, protocols/ | 现有文档和规范 |
docker-compose.yml, Dockerfile | 部署方式 |
.github/workflows/, .gitlab-ci.yml, Jenkinsfile | CI/CD |
.env.example, config/ | 配置项 |
| 数据库 migration 文件 | 数据模型 |
Glob 搜索要避开依赖目录。优先用明确路径，例如 .github/workflows/*.yml、Dockerfile、根目录下的 compose 文件；必须用 ** 时，用 path 限定范围，避免扫到 node_modules、vendor、.venv。
按项目规模选择扫描深度：
扫完先给用户摘要：项目一句话、关键模块、还缺什么信息。连入口文件都找不到时，先问用户再继续。
默认写到：
docs/tutorials/
├── index.md
├── getting-started.md
├── architecture.md
├── api-reference.md
├── configuration.md
└── deployment.md
按项目实际裁剪。没有 API 层就不写 api-reference.md；部署只是 git push 的话，放在 getting-started.md 末尾即可。
具体章节骨架见 references/doc-templates.md。
写作前读取 references/writing-style.md。每章写完后也按里面的自检清单检查一遍。
核心要求：
不要跳过大纲确认。先确认再写，避免整套文档返工。
推荐顺序：
index.mdgetting-started.mdarchitecture.mdapi-reference.md（如果需要）configuration.md（如果需要）deployment.md（如果需要）可以用 subagent 分章写。每个 subagent 必须拿到：
npx claudepluginhub timzaak/web-dev-skillsGenerates and maintains technical documentation in readme, runbook, API, and onboarding modes using structured writing principles.
Audits existing docs and generates full project documentation in docs/ including architecture.md, getting-started.md, development.md, API refs, and ADRs. For onboarding and context sharing.
Generates documentation from code including API references, developer guides, READMEs, and architecture overviews. Matches existing styles and avoids overwriting in brownfield codebases.