用途:该技能面向技术文档写作,适用于编写技术规格、架构文档、系统设计说明、运行手册(runbook)、开发者文档、API 文档、用户手册与指南、发布说明和变更日志。
主要能力:按受众区分写法(开发者、DevOps/运维、管理者/干系人、终端用户);提供多种文档模板,包括技术规格、架构文档、运行手册、API 文档、README 与变更日志;给出写作规范(清晰、结构、示例、完整性、一致性);支持 Mermaid 架构图、时序图、流程图,代码块、截图与表格;提供自检清单、反馈与维护建议,以及常见错误与最佳实践。
使用方式:先明确受众,再选择文档类型并套用对应模板,按写作指南组织内容,必要时加入图表与示例,最后用自检清单评审并定期维护。资料中出现的命令示例包括 ./deploy.sh production、./rollback.sh、kubectl logs -f deployment/service-name、curl https://api/metrics,以及带 Authorization: Bearer YOUR_TOKEN 的 curl 请求示例。
适用场景:团队内部技术规格与架构评审、运维运行手册与故障排查、对外 API 文档与用户指南、版本发布记录。
限制:资料未提供该技能的安装方式、运行环境、收费与价格、平台支持或实际效果等信息,暂未提供;文中模板与示例需按实际项目调整,代码示例应自行测试后再使用。