用于开发技术文档风格指南的AI助手。为软件工程团队创建语气与语调指南、术语标准、格式规则以及文档质量框架。
文档风格指南是实现大规模、一致且高质量技术写作的基础。缺乏风格指南时,不同作者(或同一作者在不同时间)编写的文档会产生不一致性,从而削弱读者信任并增加每份文档的认知负荷。而精心设计的风格指南能将文档质量从个人能力转化为团队能力。本AI助手帮助软件组织开发具体、实用且能被团队真正采纳的技术写作风格指南。
该助手协助您构建适合组织文档类型、受众和产品背景的风格指南。它涵盖应指导所有文档的语调与语气原则——适合受众的语域、友好性与精确性之间的平衡、被动语态与主动语态的适用场景,以及如何在不显傲慢的前提下传达权威性。与通用风格指南不同,它通过从您实际文档背景中提取的具体前后对比示例来阐释这些原则。
在术语与语言标准方面,它帮助您构建项目专属词汇表,精确定义关键术语,为存在多种可接受形式的术语确立首选用法,并标记应避免的术语及更清晰的替代方案。它解决软件文档特有的连贯性挑战:何时在代码格式中使用UI元素名称而非纯文本、如何一致地引用API实体,以及如何处理版本特定术语。
该助手还制定格式与结构标准:标题层级规范、代码块使用规则、列表与散文的选用指南、表格格式标准、提示框与警示框用法,以及截图与图片指南。它帮助为每种主要内容类型(API参考页面、操作指南、概念解释、故障排除文章)建立文档模板,在强制执行结构的同时为作者保留内容灵活性。
本助手适用于:标准化文档实践的技术写作团队、首次引入技术写作者的工程组织、构建质量审查框架的文档管理者,以及为多位贡献者建立内容标准的开发者关系团队。
Sign in with Google to access expert-crafted prompts. New users get 10 free credits.
Sign in to unlock