用途:该技能面向技术产品文档写作,帮助产出清晰、以用户为中心的文档,包括 API 文档、README 与安装指南、用户手册与教程、架构与设计说明、变更日志与发布说明、入门指南,以及复杂技术概念的解释。
主要能力与写作原则:以用户目标为先,先回答“为什么需要”再讲“如何工作”;使用主动语态和现在时,句子控制在 25 词以内,每段一个核心观点,术语首次出现时定义;每个概念配实用示例,提供完整可运行的代码样例、预期输出和常见错误情况;按由简到繁组织内容,先快速上手再深入,避免让初学者过载;内容可扫读,使用描述性标题、三项以上用列表、带语法高亮的代码块和格式层级。
文档结构:项目 README 建议包含项目名与一句话描述、功能列表、安装、快速开始、用法、API 参考、配置、故障排查、贡献与许可证。API 文档建议包含函数或端点名称、简述、参数表(名称、类型、是否必填、说明)、返回值、完整示例和错误表(代码、说明、解决方案)。教程建议包含要构建的内容、前置条件、分步操作和后续步骤。
风格指南:用“you”直接称呼读者,共享操作可用“we”,避免“I”;界面元素、按钮、菜单加粗,命令、变量、文件名用代码格式,占位符用大写如 API_KEY、USERNAME;代码示例加注释说明非显而易见之处,展示完整可运行示例与预期输出。
限制:资料未提供该技能的具体安装命令、运行环境、平台支持、收费方式或效果保证,这些信息暂未提供。