翻译技术速递
制定文档计划是非常有必要的。 其中主要一点就是制定一个明确、公开的帮助创作流程。 创建文档计划意味着给每个团队成员一个详尽的参考。 整个团队将在计划的指导下行动，以确保一致性和高效性。
文档计划的结构
对于文档计划的详细程度，并没有严格的规定。但是，如果您真的想让用户使用它，那就确保它结构明晰，易于导航。 不要让技术作者不明所以——首先，这个文档应该易于应用。
当然，文档的结构取决于任务的具体情况。 文档结构可以是基于产品的，基于角色的或是基于领域的。 但是在大多数成功的文档计划中，都保留了一个特定的结构，我们稍后会讨论这一点。 此外，我们还将就文档计划中应包括哪些数据给出一些建议。
文档计划本身有点像用户手册，因此您会发现它与一般的技术写作有很多相似之处。 文档计划的结构应当逻辑明确。不用为此抓狂，为了写而写，但至少您可以确保信息易于查找。 为此，用您喜欢的导航元素。我们当然建议使用TOC（目录）。 交叉引用、面包屑导航、下一篇/上一篇文章链接也很好，但这首先取决于您为文档计划选择的格式。 一些技术作者把所有信息都放进一篇长长的文档中，并以TOC作为主要的导航工具。 这可能对某些人很有效，但我们认为，就像创建用户手册那样，使用帮助创作工具创建文档计划效果最好。 导航元素等所有功能都已经具备，您可以将自己的最佳实践应用到文档计划创建中。
文档计划的内容
创建文档计划是为了保证目标与行动的一致性，所以它从写下项目的目标就开始了， 这对于后续工作具有决定作用。
任何文档计划都离不开完整的内容计划。 对于您要创建的用户手册，它提供了一个很好的全局视角。 而且，也许您在生产开始之前会想到改进方法。 当然，开始一个项目之前，时间框架是必要的——这是下一个需要包括的重要内容。
当我们了解该做什么后，就该涉及负责人了。 如果您愿意，可以通过明确描述角色和职责来详细列出此表。相关人员如何与内部、外部团队沟通以及具体流程——这些应该以工作流描述的形式包括在列表中。
现在，是时候选择您的团队将在该过程中使用的工具和资源了。 在列表中添加完成任务所需的软件，网站和服务。 如果您有一个单独的风格指南，您可以作为参考。 您也可以添加一节设计相关的内容，比如字体和字体系列、颜色、页面布局和图片大小等。当然，不要忘记表明所有这些工作的输出应是什么，包括输出的类型及其格式。
任何您认为重要的东西都可以包括在内。 您可以为主题和平均主题长度等设置一个理想的可读性分数。虽然文档计划的核心应该保持不变，但是如果现实需要添加一些内容，您可以添加细节，无需顾虑。
结论
文档计划的存在意味团队拥有坚实的基础。您的整个团队将拥有大量参考资料，这对任何规模的项目都是非常有利。
当您开始新项目或者在文档项目的重大迭代之前，文档计划是非常有用的。 您使用文档计划吗？您制定得有多详细？请在下面的评论区中告诉我们。
祝您技术写作一切顺利！
ClickHelp小组
跨平台和设备编写、存储和交付文档
以上中文文本为机器翻译，存在不同程度偏差和错误，请理解并参考英文原文阅读。
阅读原文