Agent Skills
返回列表
开发者文档站信息架构

开发者文档站信息架构

知识管理 更新于 2026.08.29

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

请根据安装指南 https://skillhub.cn/install/skillhub.md,将 @user_fccf428b/docs-page-generator-development-guide 安装到 AI 助手中。

技能介绍

这个技能解决什么问题

文档站的信息架构往往到项目后期才开始补救:导航层级混乱、新用户找不到上手路径、API 文档与教程互相割裂、搜索覆盖不全。这个技能把信息架构设计变成一次结构化梳理——先确认产品形态和读者对象,再产出分区方案与每个分区的内容清单。

核心能力与工作流程

  • 项目上下文识别:若存在 .claude/project-context.md 或 .cursor/project-context.md 则先读取,确认产品类型、目标读者和内容来源。
  • 五分区结构:Getting Started、Guides / Tutorials、Concepts、API Reference、Troubleshooting,每个分区都给出典型内容定义。
  • 渐进式披露:入口从简单任务开始,深度内容按需链接展开;侧边栏采用可折叠的层级导航,长文档集配套全文搜索与面包屑。
  • API Reference 内嵌:作为文档站的一个分区而不是独立页面,按资源组织端点,包含认证、请求/响应 schema、错误码、限流和 cURL、SDK 示例,建议基于 OpenAPI/Swagger 保持一致。
  • 内容与可发现性:以「How to X」任务导向写作,代码示例可直接复制;文档默认可被索引,指南使用 TechArticle、HowTo 结构化数据。
  • 输出物:分区与层级结构、导航设计、上手指南大纲、每个分区的内容清单、子域或路径建议。

适用边界

  • 只产出规划和清单,不生成完整文档正文。
  • 不自动安装依赖、修改系统权限或创建持久化任务;涉及发布、删除、部署等外部写入操作,需先说明目标与影响并取得确认。
  • 这里的 API Reference 是文档站分区;如果需要独立的 API 介绍页,应改用 api-page-generator。

使用场景

  • 文档站缺少分区,整理 Getting Started、指南、概念、API Reference 与故障排查结构
  • 读者常找不到上手路径,用渐进式披露设计首页、可折叠侧边栏和面包屑导航
  • API 文档散落独立页面,将认证、请求响应、错误码、限流与示例并入文档分区
  • 上线长文档集,为侧边栏增加全文搜索,并补 TechArticle、HowTo 结构化数据

适合人员

  • 后端工程师,需要设计 API 文档站的分区和端点组织方式
  • 技术文档工程师,为新产品撰写 Getting Started 与指南目录
  • 开发者体验负责人,优化文档导航与搜索以降低上手成本
  • 独立开源作者,在缺少专职文档团队时规划文档站结构