将产品功能转化为实用指南
- 准备引导范围
查看文档部分及其目标受众。
- 回答内容问题
明确指南应解释的工作流程和信息。
- 遵循公共服务指南
检查构建进度以及文档站点地址。
说明如何使用该应用程序。
文档通过提供实用说明来补充产品演示。从“入门”开始，然后引导用户完成应用程序实际支持的工作流程。
文档配置会显示章节定义和问题。提供上下文，以用户使用的语言帮助解释任务。
保持该指南与正在运行的应用程序的连接
支持第一个有用的操作. 新手入门指南为新用户提供了一条通往该产品的简短路径。它应该解释从哪里开始、需要哪些信息以及哪个结果可以确认任务已完成。
解释一个循环工作流程. 以下是一份详细的指南，其中包含实际的应用标签和操作。先决条件、编号步骤和预期结果可以帮助用户重复执行业务任务，而无需解释屏幕上的通用描述。
回答一个跨领域的问题. 一些问题涉及账户、成本或发布，而不是单个屏幕。常见问题解答提供简洁的答案，并链接到相关指南，使程序集中在一处，而不是在整个网站中重复。
请保持指南与产品之间的连接
在进行有意义的应用更改后，请查阅文档。指南应使用用户实际能够看到的功能和行为。
该文档在其独立的公共服务中运行。从网站链接到该文档，并检查您项目发布的语言中的指南。
帮助用户完成下一个任务
一本实用指南，解释了从哪里开始、需要哪些信息以及如何检查结果。它的价值在于帮助读者在应用程序中采取行动。
当任务涉及多个区域时，请使用相关指南继续操作。当屏幕发生变化时，请查看文档，以便在界面更新后，指南仍然有效。
从约定的功能到有用的帮助
准备引导范围. 查阅文档的各个部分以及它们应该解释的任务。 始终明确目标用户和应用程序的行为。
提供缺失的上下文. 回答关于先决条件、规则和结果的问题。写作应使用真实的界面，而不是虚构的控件。
发布后查看并修改. 请在应用程序中按照指南操作，查看其语言和相关链接，然后在底层任务发生变化时重新查看。
关于产品文档的问题
功能页面有助于潜在客户了解该功能及其价值。指南帮助用户执行任务，提供实际控件、先决条件和结果。两者相辅相成。
该文档工具会显示各部分定义和问题。请查看应用程序支持的任务，提供缺失的上下文，并跟踪编写进度。
该项目发布了其范围内的本地化指南。请审核每种已发布的语言版本，以确保其保留了完整的流程和正确的界面标签。
在对任务、其控件或预期结果产生影响的更改后，请将文本与正在运行的应用程序进行核对，而不是假设原始说明仍然有效。
端点引用属于一个具有活动、可用的 API 的项目。使用其实时操作和实际引用；计划的路由不足以记录可用的集成。