Agent Skills
返回列表
项目文档初始化器

项目文档初始化器

开发编程 更新于 2026.08.29

将以下提示词粘贴到你的 AI 对话框中：

请根据 https://skillhub.cn/install/skillhub.md，安装 @user_81da3431/project-doc-init。

技能介绍

解决什么问题

很多代码项目缺少给工程师或 AI 协作使用的统一入口：行为准则、目录约定、常用命令、接口规则分散在聊天记录或口头约定里。project-doc-init 针对这类问题，直接从项目本身出发，识别技术栈和架构特点，生成一个可维护的 AGENTS.md，并按需要拆出 docs/ 子文档，让后续改动有明确查阅路径。

如何工作

技能激活后无需额外参数，会读取配置文件与目录结构，检测 Vue、React、Node、Go、Python 等项目类型，再按项目复杂度决定文档粒度：

  • AGENTS.md：承载行为准则、场景化导航和常用命令，作为统一入口。
  • docs/PROJECT.md：记录技术栈、目录结构等基线信息。
  • 专项子文档：如 docs/API.md、docs/COMPONENT.md、docs/ARCHITECTURE.md、docs/DATA_MODEL.md，只在接口、组件、架构或数据模型值得独立说明时生成。

文档路径使用相对路径，便于迁移；小项目可能只输出 AGENTS.md 和 docs/PROJECT.md。

边界与注意点

该技能适合已有代码结构的开发项目，不预设固定模板。若缺少 package.json、go.mod 等关键配置，或无法识别技术栈，它只基于可确认信息生成基线文档，并把不确定部分向用户提问；配置文件缺失时，不会强行生成动态专项文档。

使用场景

  • 接手一个 Vue 仓库后，需要快速梳理技术栈、目录结构和常用命令，形成统一入口。
  • 在 Node CLI 工具项目里，把参数说明、技术栈和目录约定整理成基线文档。
  • 为前后端分离项目补充接口约定、架构决策和数据结构说明，拆分到 docs 子文档。
  • 配置文件缺失时，只基于目录结构生成可确认的 AGENTS.md 与 PROJECT.md，并标注待确认项。

适合人员

  • 维护 Vue 前端仓库的前端负责人，需要把组件规范和常用命令沉淀成团队入口。
  • 接手 Node CLI 工具的后端工程师，需要快速确认参数说明、技术栈和目录约定。
  • 维护全栈项目的技术负责人，需要把接口、架构决策和数据结构分开成文档。
  • 给编码代理配置项目规则的工程负责人，需要一份稳定的行为准则与场景导航。