用途:该技能用于规范产品文档的编写,覆盖用户指南、功能文档、发布说明与终端用户沟通,目标是让文档清晰、全面、面向用户,帮助用户理解功能、解决问题并最大化产品价值。
主要能力:文档类型分为三类。用户指南(必备)包括入门指南、功能文档、故障排查指南、FAQ 和术语表;发布文档包括发布说明(新功能、缺陷修复、破坏性变更)、迁移指南、升级说明和弃用通知;参考文档包括功能规格、配置选项、键盘快捷键或 CLI 命令、系统要求。
写作标准:要求使用清晰简洁的语言,面向目标受众的技术水平写作,使用主动语态(如“Click Save”而非“Save should be clicked”),包含截图、图表、视频等视觉内容,提供示例,并保持与产品同步更新。
结构模板:按功能名称、概述(作用与价值)、前置条件、使用方法(分步骤并配截图)、示例(真实用例)、故障排查(常见问题与解决方案)、相关内容(相关文档链接)组织。资料中给出的功能文档示例为“邮件通知”,包含设置步骤(进入 Settings → Notifications、切换事件、验证邮箱、点击 Save Preferences)、通知类型(安全警报、系统更新、账户活动)及故障排查。
适用场景:产品团队编写和维护用户指南、功能说明、发布说明、迁移与升级文档、参考手册及终端用户沟通材料。
限制:资料未提供该技能的具体安装方式、运行命令、平台支持、收费模式或实际效果数据,这些信息暂未提供。