有些人认为编写文档是在编码完成后开始的。毕竟，如果应用程序尚未构建，您怎么可能解释如何使用它呢？对吧？
不！其实，尽早开始写作非常重要。当文档被当做代码来对待时，效果会更好：原型化，根据需要丢弃，迭代和改进。
文档的第一次编写可能远非完美，但这没关系。重要的是开始写下你的想法，以便你可以反复重写、编辑和重写，就像你努力使代码实现其目标并无错误运行一样。
“你的文档的第一遍可能远非完美，但这没关系。重要的是开始写下你的想法，这样你就可以一遍又一遍地重写、编辑、再重写——就像你努力使代码实现其目标并无错误运行的方式一样。”
如果您有资源，让没有参与开发应用的人来编写 智利 WhatsApp 数据 文档通常是一个好主意。例如，专业的技术作家或内容设计师可以为您设计和编写内容。但即使您聘请某人来写作，也要尽早让他们参与您的项目，以便他们有足够的背景知识。有关这方面的更多信息，您可以查看我在 Medium 上的文章，您的技术作家是配角还是主力？
您或许还喜欢： 揭穿关于原型设计的 10 个误区。
4. 创建基于任务的文档
套用一句老话，你可以为某事物创建两种不同类型的文档：它如何运作，以及如何运作它。
工作原理文档往往更具技术性，通常更像是技术人员的参考资料。这有时也称为以功能为中心的内容。
但您应该为您的应用创建解释如何使用它的内容。换句话说，提供说明，向商家展示如何使用您的应用来实现他们的最终目标。这通常称为基于任务的文档。
“提供说明，向商家展示如何使用您的应用程序来实现他们的最终目标。”
商家将您的应用添加到Shopify 商店后，他们希望它能为他们解决问题。但根据您的应用的功能，他们可能首先必须对应用进行一些配置，将一些数据传输到其中，或以其他方式进行设置，以便它能够开始工作。
这些是您可以重点撰写的首要任务：根据他们的特定需求配置和设置应用程序。
然后，您可以继续执行他们使用该应用程序需要执行的下一个任务。
为了让您更好地了解两种截然不同的内容类型，下面举个例子。以功能为中心的文档可能有一个名为“CSV 文件结构”的主题，其中描述了逗号分隔值文件中的列以及每列的数据类型，还有一个名为“CSV 导出”的主题，其中介绍了该文件中的数据如何被其他系统使用。
相比之下，基于任务的文档可能包含如下标题的主题：
将您的产品添加到 CSV 文件
验证 CSV 文件中的产品
将您的库存导出到另一个系统
请注意，即使单独列出标题，标题也能以有用的语言传达商家可能想要执行的任务。它们还使用商家可能熟悉的任务导向型单词和术语。
商家通常会对基于任务的文档感到更满意。Shopify帮助中心的大部分内容都使用基于任务的内容，如Kit 应用主题的此示例所示：
技术文档：Kit 文档中主题的屏幕截图。Kit。设置。与 Kit 对话。使用 Kit 进行营销。发布到社交媒体。报告。
我们的 Kit 文档中的主题。
您或许还会喜欢： 改善应用支持的 5 个关键策略。
5. 让其他人审阅并测试你的文档
您的文档需要像应用程序本身一样仔细地进行审查和测试。让不太熟悉您应用程序的人来做部分审查非常重要。不要只依赖您自己！
让其他人审阅您的文档的一大好处是，他们不是您应用方面的专家。由于独立审阅者与开发过程有一定距离，他们不会掌握您掌握的所有知识，因此不会做出您可能做出的假设。有时这被称为“知识的诅咒”。要了解有关此概念的更多信息，请参阅Wikipedia或 Steven Pinker 的《风格感》一书。
总之，如果您自己进行评论，您可能会受到您对应用程序的专业知识和所写内容的微妙影响。相比之下，如果有人带着全新的眼光来评论，他们将更有可能注意到是否需要更注重任务的方法、补充文档可能有用的空白、过时的信息，甚至是您可能看不到的奇怪拼写错误。
除了开发人员之外，其他人的审核也总是会对您的文档有所裨益。
出色的文档意味着满意的用户
为应用程序创建文档可能不是您的待办事项清单中最重要的或最喜欢的事情，但创建出色的文档以帮助商家有效地使用您的应用程序确实值得付出努力。
本文中的提示只是对创建技术文档所涉及的所有内容进行了粗略介绍。如果您想深入了解，这里有一些可供探索的进一步资源：
Write the Docs 是一个在其网站上拥有大量信息的组织，其中包括文档指南。
撰写的《用户体验的战略写作》侧重于用户界面内容，但在这本薄薄的书中涵盖了很多内容。
Bold Commerce创建了许多 Shopify 应用，并附带相关内容。查看他们的文档处理方法。
无论您如何创建文档，请记住关注商家的目标，保持语言简单直接，并确保在发布之前让其他人审查您的技术文档。
为 Shopify 商家构建应用程序
无论您是想为Shopify 应用商店构建应用、提供自定义应用开发服务，还是想寻找扩大用户群的方法，Shopify 合作伙伴计划都能助您成功。免费加入并访问教育资源、开发人员预览环境和经常性收入分成机会。