翻译技术速递
编者注：本用户指南模板是帮助读者计划和管理沟通和内容管理活动、资源和交付件的一系列模板之一。我们欢迎对其他Techwhirl模板库材料提出想法和建议。
用户指南（又名用户手册）提供了设置和使用产品所需的信息和说明。用户指南包括书面和视觉信息（如图表或屏幕截图），以帮助用户完成与产品（或服务）相关的任务，并按功能或工作流程线进行组织。
目的：
《用户指南》解释了如何使用产品执行某些操作，通常还包括原因以及如果未正确执行任务会发生什么情况。结构良好的《用户指南》提供了适合产品典型用户的信息，并以简洁、无术语的语言提供了过程和完成过程的上下文。
相关性：
此用户指南模板旨在支持基于工作流的方法或功能方法来执行与产品相关的任务。大多数技术交流人员使用这种格式来记录软件或硬件。通过一些调整，您可以轻松地使用此模板来记录整个范围的电子、制造或其他硬件产品，以及复杂的流程或服务流。
传统的用户指南，特别是软件应用程序的用户指南，通常记录每个可用的功能和选项，并按照在用户界面中如何访问这些功能来组织。越来越多的技术传播者（技术作家、用户协助专家、内容开发人员等）订阅以用户为中心设计和文档方法，并开始放弃对每个可用函数的详尽文档。这种形式的用户帮助使用业务工作流来组织信息和说明，因此可以围绕使用所记录的产品执行与业务角色或活动相关的一组任务来组织章节。在这两种情况下，您都应该利用开发文档，比如用例、用户故事（Agile）或人物角色，来确定要涵盖哪些特性以及以什么顺序涵盖。
此用户指南模板包括一组样式，可支持最终转换为其他格式。它遵循文档的传统顺序路径，而不是数字媒体所需的组件化、基于主题的内容创建风格。但是，由于它的结构支持功能或工作流，因此它可以作为尚未使用CCMS或结构化创作工具的技术沟通者的良好起点。
使用模板：
确定用户指南的目的并确定受众。
围绕用例或用户情景查看开发文档，以确定如何组织要包含在每章和小节中的内容和信息。
勾画出要涵盖的工作流程。
制定指南内容的大纲
下载用户指南模板（Word - .docx）文件并保存到本地位置。
根据公司的指导方针自定义页眉和页脚以及其他样式。
研究和开发内容并将其编译到模板中。
使用大纲制定目录。
考虑包括产品（或行业）特定的术语表。
根据长度制定索引。
测试指南。
修订指南中的内容。
生成最终草稿，并以所选的交付格式发布。
遵循组织关于文件保留的政策和指导方针，管理草稿版本和后续修订版本。
获取反馈、评估和修改内容（如适用）。
您可能需要下载情节提要模板，以帮助您勾画出要涵盖的工作流。 如果你不熟悉索引，看看索引常见问题。
下载：用户指南模板（168 kb - Microsoft Word）
您是否有其他用户指南模板可以很好地用于您正在记录的产品？您是否处于敏捷开发环境中，并且拥有创建与Sprint一致的用户帮助的工具？请随时联系我们并提交您的模板。我们将为您提供信用协助TechWhirl社区和模板星期二的贡献。
以上中文文本为机器翻译，存在不同程度偏差和错误，请理解并参考英文原文阅读。
阅读原文