项目文档生成器
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @kunlungrowth/project-docs。
技能介绍
先承认问题:代码库的真相不在 README 里
多数项目的文档要么缺失,要么停留在两年前最后一次有人认真更新的时刻。新成员想确认 src/routes 下到底注册了哪些端点,只能在十几个文件里反复跳转;接手重构的人想知道数据表结构,只能去翻迁移脚本。结果是文档与实际代码逐渐脱节,最后没人再信。
核心能力:从静态分析生成结构化文档
这个技能先扫描项目根目录,依据配置文件识别项目类型,再只提供与当前代码匹配的输出选项。
关键步骤
- 判定项目类型:识别
wrangler.toml、astro.config.mjs、drizzle.config.ts、pyproject.toml等特征,判断这是 Cloudflare Worker、React SPA 还是含数据库层的服务端应用。 - 询问目标文档:可选
ARCHITECTURE.md、API_ENDPOINTS.md、DATABASE_SCHEMA.md。静态站点不会出现接口文档,没有数据库的项目也不会凭空生成 schema。 - 扫描代码库:读
package.json与依赖版本、路由定义、中间件、Zod schema 或类型声明、迁移文件与种子脚本。 - 写入文档:默认写入
docs/,已存在时提供更新而非覆盖。
质量规则
- 记录已经存在的端点、表和字段,不把计划中的功能写进文档。
- 版本号直接从锁文件提取,不靠记忆补写。
- 响应形状照抄代码里的 TS 类型或 Zod schema。
- 架构信息若与
CLAUDE.md重复,改为引用而不是复制。
适用边界与注意点
不写与代码无关的路线图或产品愿景,也不覆盖现有文档。发现未完成的功能或前后不一致的声明时,会在文档中明确标出,而不是悄悄补全。
使用场景
- 新项目缺少初始文档,需要从代码库生成架构说明,帮助成员快速理解系统。
- 接口文档缺失或过时,要求扫描路由与 Zod schema,输出真实的 API 端点列表。
- 数据库迁移脚本堆积,需要从 Drizzle schema 与迁移文件生成当前表结构说明。
- 项目重构后文档陈旧,要求基于现有代码更新架构与接口文档,而非重写愿景。
适合人员
- 后端工程师,需要快速确认服务端到端接口签名与鉴权方式,避免反复翻路由文件。
- 前端工程师,接手 React SPA 时想从 ARCHITECTURE.md 了解目录结构与关键模块导出。
- 数据库管理员,希望从迁移文件和种子脚本反向生成 DATABASE_SCHEMA.md,核对表关系。
- 技术负责人,在重构前需要一份反映真实代码的架构文档,作为评审与对齐的基础。