开发人员文档是每个新的移动或web应用程序的基础。这是由于当今IT世界的持续集成过程。孤立的软件根本不存在了。它意味着许多相同或相似的特征 (代码元素) 被复制和复制。如果您的公司开发人员足够聪明，他们将不会每次都从头开始编写代码。高效的开发人员文档可以帮助您编写更少的代码，并节省创造性工作的时间。 什么是开发人员文档？ 开发人员文档是您的技术作者创建的所有文档，用于在各个阶段支持您的产品，从熟悉产品到将其完全纳入客户系统。这些阶段使文档开发生命周期 (DDLC)。 例如，在初始阶段，信息通常由入门指南或QSG (快速入门指南) 表示，该指南将引导您完成第一个概述阶段。它可以包括安装、身份验证、设置、需求问题等。在可以帮助您更深入地了解产品的情况下，可以表示信息。例如，您的用户可以学习如何将WhatsApp API集成到他们的系统中，以通过WhatsApp访问其用户。 熟悉产品后，您将需要一个特写视图来继续学习。在此阶段，您将需要特定于语言的文档 (源代码文档)，以帮助您编写过程。您需要选择与目标软件兼容的合作伙伴系统的语言。 在这个阶段也需要UX文档 (用户场景，用户角色，用户风格指南等)，因为您必须使您的应用程序用户友好。为此，有必要详细说明用户场景或用户地图以优化用户的移动。用户角色可以成为重要的信息来源，因为它们可以解释用户的思维方式，目标和兴趣。 在最后阶段，您将需要报告和指标来评估软件功能。最常见的质量保证文档类型有质量管理计划、测试策略、测试计划、测试清单等。 您的开发人员通常会从您感兴趣的产品开发人员那里获得SDK (软件开发工具包)。它看起来像一个程序包，在它的帮助下，用户可以立即开始工作。现成的库将允许您多次重用高质量代码。一个可用的SDK可以在不同的上下文中重现一个示例代码。 优秀开发人员文档的组件 API文档就像开发人员文档的 “砖块”。API代表应用程序编程接口。它有助于创建新的应用程序以与目标程序进行交互。开发人员可以组合和配置各种api，以使产品对用户更具吸引力，并将其与其他api集成。 我们在日常生活中使用的API的一个简单示例是可以帮助您在Facebook或Instagram等社交媒体上刷新页面的API。你拉下你的页面刷新，看到一个旋转的轮子。这是一个简单的用户实际看到的。实际上，在这几秒钟内，您已经联系了Facebook或Instagram API，并提出了刷新时间轴的请求。结果是来自您的朋友和您关注的页面的新照片和帖子。 开发人员文档的最佳实践 撰写技术文档需要作者的技术背景。技术作家必须能够 “穿行” 用户和开发人员。如果他们没有这样的超级大国，这可能会导致许多错误。 大多数此类错误是指滥用术语或对过程的理解。为了避免这种情况，一些公司让工程师自己编写sdk。在这种情况下，技术错误的数量肯定会下降。但是，开发人员的写作技巧往往远非完美。有时，他们对写作风格一无所知，也不知道文档应该是什么样子。 因此，最佳实践是确保技术作家和工程师之间的协作。你应该让写的人偷看一下开发过程。同时，您应该尝试让开发人员参与审查创建的文本。 还建议将代码文档分为两个主要集群: 编码和测试文档。前者描述了用于数字产品的代码。编码文档向开发人员和产品所有者展示了该软件的工作方式。在这里，技术专家的帮助对于有时无法解释代码的复杂部分并需要帮助的作家尤其重要。 测试文档是另一个集群。它是质量保证过程的一部分。它有助于解释产品是如何被验证的。有不同类型的文件涉及测试过程，例如，测试计划，测试程序说明，测试总结报告等。 从用户的角度来看，过多的文档会使事情变得过于复杂。人们喜欢可以直观使用的产品。这里的主要建议是提供足够的内容，但质量很高。 请注意，用户不会阅读看起来像博士学位的文档。在核物理学中。因此，请避免使用技术术语，并以简单，易于阅读的方式呈现信息。 交叉链接可以使信息更容易理解，同时减少专门用于一个问题的文本数量。要查找有关相关主题的信息，读者可以单击链接并更详细地探讨该问题。 点击帮助作为开发人员文档工具 使用帮助创作工具可以促进开发人员文档的创建。ClickHelp可以改善您的文档外观，并使技术作家的工作更加轻松。 借助语法荧光笔，ClickHelp可以以易于阅读的格式呈现代码示例。它将在视觉上将代码片段与常规文本分开。 ClickHelp可以称为所见即所得编辑器。它有助于说明具有不同类型内容的文档，例如屏幕截图，图表，图表，图像等。否则，不仅对于新手，而且对于经验丰富的用户，您的文档都将很难 “消化”。 除了视觉部分，还有更基本的方面。它是单一来源，可确保所有技术作者引用相同的信息来源。它有助于使整个文本在词汇表，术语和定义方面统一。 ClickHelp提供的另一个功能是内容重用。这意味着作者没有必要在每次出现时涵盖相同或相似的主题。类似的内容可以修改重复使用。 还有团队合作之类的东西，这将有助于简化写作过程。它通过使多个作者能够处理同一文档或一组文档来确保优化。可以通过添加更多角色 (例如审阅者和翻译人员的角色) 来扩展此过程。这意味着文档可以由多个作者创建，由多个审阅者编辑，并由内部或外包翻译团队同时翻译。项目成员之间的角色分配将使整个过程更快。 ClickHelp工具还使该过程具有交互性，因为注释以 “实时” 在线格式提供。所有这些 (以及更多) 功能的结合都可以帮助您生成出色的开发人员文档。 结论 软件文档背后的想法是节省时间和精力。它是一种集成移动或web应用程序的工具，也是一种强大的营销工具。为开发人员提供一组描述如何使用api的文档，可以提高产品的适销性。 结果将是推出新项目的数量和速度更高，测试良好且可靠的代码数量更多，新客户的条件更好，最终利润更高。 祝你的技术写作好运! 点击帮助团队 跨平台和设备编写、托管和交付文档