出色的文档意味着满意的用户
实际上，并不是很多开发人员都喜欢编写技术文档 - 他们宁愿编码！但有时文档是您交付内容的必要部分。这些提示将帮助您创建有效的内容来支持面向商家的Shopify应用。
不过，在深入讨论之前，我们先来澄清一下“文档”的含义。在这里，我们将介绍一些有关创建文章或主题以配合您的应用的高级概念：帮助商家开始使用您的应用、教他们如何使用应用以及在他们遇到任何问题时提供帮助的附加内容。它通常被称为帮助或文档。
尽管这类文档与您的应用无关，但最好将其视为您整体产品不可或缺的一部分，换句话说，要像设计和编写应用本身一样小心谨慎地对待它。您的技术文档也像是一种营销工具：它展示了您的专业性，反映了应用的质量，并可以提高应用的采用率。
为 Shopify 商家构建应用程序
无论您是想为Shopify 应用商店构建应用、提供自 智利 WhatsApp 数据 定义应用开发服务，还是想寻找扩大用户群的方法，Shopify合作伙伴计划都能助您成功。免费加入并访问教育资源、开发人员预览环境和经常性收入分成机会。
报名
1. 通过可靠的用户体验最大限度地减少对文档的需求
设计良好的应用将具有出色的用户体验，并且只需看一眼就能轻松了解其许多功能。这很好！您需要编写的文档越少越好。商家需要阅读的文档越少，对他们来说就越好。
应用程序本身的文字（通常称为用户界面文本）至关重要 - 这些文字是使用您的应用程序的商家会看到的，并且会在他们每次使用时提供指导。
此用户界面文本本身就是一种文档。应用通常包含商家可以输入数据的字段、可点击的按钮等。确保所有这些用户界面元素都有有用的标签，这样字段的用途就一目了然了。
如果标签不足以准确传达应用的某个部分需要做什么，您可以在应用中添加简短的文字来解释在特定屏幕或区域中需要做什么。例如，Shop 应用对以下设置使用了简短的说明：
技术文档：Shop 应用程序中设置的屏幕截图显示了 Confetti、自动暗模式和启用暗模式设置的简短说明，从而最大限度地减少了对技术文档的需求。
商店应用程序的简短文本向用户解释了设置的作用。
标签和附加文本的组合可以清楚地显示具体设置的用途。
我们不会详细介绍此类文档，但请查看Shopify Polaris 指南，获取有关为您的应用构建最有效的用户界面内容的详细信息。
但一般来说，您的应用程序在用户界面上的记录越好，商家使用起来就越容易，而且您对随附技术文档的需求就越少。
您可能还喜欢： UX 写作：制作有效内容的 10 个技巧。
2. 始终牢记应用的用户（Shopify 商家）
正如您为商家设计应用程序一样，也请为商家设计文档。
“就像您为商家设计应用程序一样，您也要为商家设计文档。”
例如，您的应用在设计时很可能对用户已知的信息抱有一定期望，无论是关于库存、营销、运输还是经营业务的其他方面。您的文档应使用商家在日常工作中熟悉的语言。
主题标题的示例可以最好地展示这一点。假设您创建了一个应用程序，可帮助处理在线退货和换货的某个方面。现在想象一下商家在您的文档中遇到这个主题标题：
产品重新送交销售地认证
嗯？这听起来好像翻译得很糟糕。如果是这样呢：
授权产品退货
这更有意义！修改后的标题使用了商家理解且可能每天都会使用的语言。浏览您的文档的人会立即知道此主题涵盖的内容。
确保您在文档中使用的词语对于商家来说是常见的且有意义的。
“确保您在文档中使用的词语对商家来说是常见的且有意义的。”
技术术语也是如此。作为开发人员，您可能非常熟悉 API、方法和错误日志等术语。但许多商家不知道这些术语的含义或它们与使用您的应用有何关联，因此请避免在您的内容中使用这些术语。
使用商家语言的文档的一个很好的例子是Shopify帮助中心中的Launchpad 内容。它的第一行解释了这个 Shopify Plus 应用程序的功能以及它针对的特定商家活动。