用途
本技能用于帮助用户按标准模板撰写结构化的技术设计文档(技术方案 / RFC),并将其保存到团队的语雀知识库,供团队评审。它面向团队协作场景,文档存放在团队仓库中。
主要能力
- 按标准模板生成技术设计文档,涵盖背景、目标、方案设计、技术选型、方案对比、排期、风险评估、参考资料等章节。
- 在生成前收集需求信息,并通过追问澄清模糊点。
- 可选地检索语雀中已有的相关文档,避免重复设计、引用先前决策、了解现有架构。
- 定位目标团队知识库并将文档创建为草稿。
- 生成后可向用户展示草稿并确认,再执行保存。
使用方式
使用该技能时需向用户收集以下字段:项目/功能名称(必填)、背景与问题(必填)、目标(必填)、约束条件(可选)、已有方案(可选)、团队标识 group login(必填)。若用户描述模糊,可提出澄清问题,例如「这个功能要解决什么问题?」「有什么技术约束吗?」「预期的时间节点是什么?」。若未提供团队标识,需向用户询问团队的语雀团队标识,以便把技术方案存入团队知识库。
工作流程大致为:
- 理解需求,收集上述字段。
- (可选)使用 yuque_search 检索相关已有文档,参数如 query 为相关关键词、type 为 doc。
- 加载 references/template.md 模板,基于用户输入和技术分析填充各章节。核心章节包括背景、目标、方案设计(架构图文字/ASCII 描述、核心组件及职责、数据模型/API 设计、关键流程)、技术选型、方案对比、排期、风险评估、参考资料。
- 将草稿提交用户确认,询问方案内容是否准确、是否需要调整、是否补充技术细节。
- 使用 yuque_list_repos(参数 login 为 group login、type 为 group)查找目标团队仓库(常为「技术方案」「设计文档」或「RFC」)。
- 使用 yuque_create_doc 创建文档,参数包括 repo_id(命名空间,如 my-team/tech-docs)、title(如「[技术方案] 项目名称」)、body(格式化后的设计文档)、format 为 markdown。
- 确认结果,提示文档为草稿状态,请团队评审后发布。
适用场景
- 用户想撰写并保存技术设计文档或 RFC 到团队仓库。
- 用户表示「帮我写技术方案到团队库」「write a tech design for the team」「团队技术方案」。
- 用户描述某个功能或系统,需要将其整理成正式设计文档供团队评审。
依赖与限制
- 所需 MCP 工具全部来自 yuque-mcp 服务器:yuque_search(可选)、yuque_list_repos、yuque_create_doc。
- 完整模板位于 references/template.md,生成文档时需加载。
- 需要团队的 group login;未提供时须向用户询问。
- 团队仓库需要团队级 Token,未配置 Token 时需告知用户。
- 本技能保存到团队仓库;个人仓库应使用 yuque-personal 插件中的 tech-design 技能。
- 默认使用中文撰写设计文档,除非用户指定英文。
- 用户需求模糊时,可做出合理假设并用「【假设】」标记说明。
- 文档结尾始终提示「请团队评审后发布」,因为团队设计需要评审。
- 若 yuque_create_doc 失败,可展示错误并提供将 markdown 手动复制的方案。
- 若用户想更新已有设计文档,可先检索找到它,再建议创建 v2 或附录。
错误处理
- 用户提供的信息过于模糊:在生成前提出 2-3 个针对性问题。
- yuque_search 发现存在冲突的既有设计:指出并询问用户如何处理。
- yuque_create_doc 失败:展示错误,提供输出 markdown 供手动复制的选项。
- 用户想更新已有设计文档:用 yuque_search 查找,再建议创建 v2 或附录。
- 未提供 group login:向用户询问团队的 group login。
- 未配置团队 Token:告知用户团队仓库需要团队级 Token。
暂未提供的信息
资料未提供具体价格、收费方式、支持平台或其他量化效果数据。