Agent Skills
返回列表
💻

文档架构师

开发编程 更新于 2026.08.30

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

请根据 https://skillhub.cn/install/skillhub.md,安装 @org-02qudk26/docs-architect。

技能介绍

要解决什么问题

复杂系统在代码里往往「能跑」,但缺少一份能同时回答是什么与为什么的长篇技术参考:新同事入职、架构评审、跨团队对接时,只能反复翻仓库或问原作者。本技能把「文档架构师」当作明确工作流,而不是随手写几页 README。

技能如何工作

围绕发现 → 结构 → 写作三阶段组织输出:

  • 发现:分析代码结构、依赖与关键组件关系,提取设计模式、架构决策,并映射数据流与集成点。
  • 结构:设计章节层级与渐进式披露,规划架构图/时序图/流程图(含文字描述),统一术语。
  • 写作:从执行摘要与架构概览切入,逐层落到实现细节;用仓库内具体示例说明决策理由,并给出可验证的步骤。

核心能力覆盖代码库分析、面向多受众的技术写作、系统级视角、文档信息架构与可视化沟通。产出通常为 10~100+ 页的 Markdown,并建议包含执行摘要、架构概览、设计决策、核心组件、数据模型、集成点、部署、性能、安全模型与附录等章节。

适用边界

  • 任务与 docs architect / 长篇系统文档无关时,不应强行套用本技能。
  • 需要本范围外的其他领域工具链(例如专用 API 文档生成器、仅面向用户的营销文案)时,应换用对应技能或流程。
  • 更细的示例与检查清单见技能包内 resources/implementation-playbook.md(按需打开,而非替代你对目标与约束的说明)。

使用场景

  • 接手几乎无文档的遗留服务仓库,需在招聘前写出含架构概览、核心组件与集成点的长篇技术参考。
  • 架构评审或重大重构前,要从代码中提炼设计模式与架构决策,并写成带理由说明的正式章节。
  • 多模块系统术语混乱,需要重新规划章节层级、渐进式披露,并配套架构图与流程的文字描述。
  • 运维或平台交接时,要基于现有实现补充部署架构、数据流、外部依赖及性能与安全相关章节。

适合人员

  • 刚接管复杂单体或微服务代码库的技术负责人,要在新人到岗前补齐可导航的长篇系统文档。
  • 准备内部架构评审的资深工程师,需要把「当前实现 + 决策原因」整理成评审可引用的材料。
  • 负责跨团队集成的平台工程师,要从仓库映射 API、事件与外部依赖并写入结构化集成章节。
  • 维护内部框架或开源项目的核心贡献者,希望为后续贡献者提供带代码示例与附录的权威参考。