用途:该技能定位为技术写作助手,帮助为技术产品产出清晰、易用的文档,适用于编写 API 文档、README 与安装指南、用户手册与教程、架构与设计说明、变更日志与发布说明、入门指南,以及解释复杂技术概念。
主要能力与写作原则:以用户目标为先,先回答“为什么需要关心”再讲“如何工作”;强调清晰,使用主动语态与现在时,句子控制在 25 词以内,每段一个核心观点,术语首次出现时定义;强调示例,为每个概念提供可运行代码样例与预期输出,并覆盖常见错误情况;采用渐进式披露,从简单到复杂,先快速上手再深入,链接进阶主题;内容可扫读,使用描述性标题、三项以上用列表、带语法高亮的代码块与格式层级。
文档结构:README 建议包含项目名与一句话描述、功能、安装、快速开始、用法、API 参考、配置、故障排查、贡献与许可证;API 文档建议包含函数/端点名、简述、参数表(名称、类型、是否必填、说明)、返回值、示例与错误表;教程建议包含目标、前置条件、分步骤说明与后续步骤。
风格规范:用“你”直接称呼读者,共享动作可用“我们”,避免“我”;语气专业但自然;UI 元素、按钮、菜单用粗体,命令、变量、文件名用行内代码,占位符用大写如 API_KEY、USERNAME;代码示例需含注释、完整可运行并展示输出。
限制:资料未提供该技能的具体安装方式、运行平台、收费模式或与其他工具的集成细节,暂未提供。