Agent Skills
返回列表
AI 开发文档生成器

AI 开发文档生成器

开发编程 更新于 2026.08.30

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

请根据 https://skillhub.cn/install/skillhub.md，安装 @user_f2df858a/docs-for-ai-dev 到你的 AI 助手中。

技能介绍

解决的问题

让大模型直接基于需求文档完成完整实现时，常见问题不是模型不够强，而是文档缺少可追溯链条：需求、接口、任务、错误处理、状态存储彼此脱节，字段类型或枚举策略含糊，导致 AI 只能猜测。本技能针对桌面端、Web、API、CLI、库、移动端等项目类型，生成一套面向 AI 消费的文档集。

技能如何工作

它先做 Step 0: 项目类型检测，选择对应 stack profile，再按文档结构输出：

  • D01 到 D09 的通用文档，覆盖概览、功能设计、架构、API 设计、开发指南、任务列表、错误处理、状态持久化和 AGENTS.md 入口。
  • 有 UI 时生成 U01 到 U03，包括设计系统、像素级视觉规范和交互流程。
  • 按场景加入安全性能、深度分析、多阶段任务或 i18n 文档。

核心原则是 Full-Chain Traceability：每个功能必须在 D02 功能设计中有完整数据模型接口，并映射到任务、测试标识、接口注册和状态存储。文档强调完整注解、一致枚举策略、设计 token 映射和部署完整性，减少 any、占位类型和模糊描述。

适用边界与注意点

适合需要把需求、架构和任务交给 AI 执行的工程项目，尤其是对接口契约、配置、错误码和部署产物要求明确的项目。它不是营销文案生成器，也不会自动补全缺失业务事实；如果原始需求本身缺少关键约束，输出仍需要人工审计。对于 UI 项目，要求提供页面状态、断点、可访问性和设计 token 信息，才能生成可用的像素级规格。

使用场景

  • 接到新产品需求后，要把目标、数据模型、接口和验收标准整理成可交给 AI 实现的任务文档。
  • 开发 Web 管理端时，需要把页面状态、断点、组件规范和交互流程写成像素级 UI 规格。
  • 重构 API 服务前，需要核对端点注册、错误码、状态持久化和部署回滚是否一致。
  • 维护多语言桌面应用时，要把认证、凭据管理、性能指标和 i18n 结构纳入开发文档。

适合人员

  • 负责把产品需求转成 AI 可执行开发文档的工程师，要求接口、任务和状态链路一致。
  • 同时维护前端页面与后端服务的架构师，需要把设计 token、端点注册和部署约束写清。
  • 使用 AI Agent 完成桌面应用开发的独立开发者，需要完整配置、错误处理和发布产物说明。
  • 需要审计 AI 生成代码依据的资深开发，要求文档可追溯、无占位类型和断裂引用。