Sonat

Here you have access to some useful articles provided by Sonat.

Articles

V1.0.0

创建用户手册的最佳方法是什么？

<h1>创建用户手册的最佳方法是什么？</h1><p>用户手册指导产品的组装、安装和使用。用户手册可以采用不同的形式，例如用户说明、用户指南、快速入门指南、入门指南或技术文档。</p><aside class="template-box extra-template-box" variant="extra"><div class="template-box-title">&nbsp;</div><div class="template-box-description"><p>您应该了解<a href="https://sonat.com/@sonat/articles/what-exactly-is-a-user-manual-and-why-is-it-so-important-?lang=en">用户手册对您的业务的重要性</a>！</p></div></aside><p><img class="image-style-align-right" src="/api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/73acaa39-a93f-4c69-9c7e-50f08fb6cde8.webp" alt="创建用户手册" srcset="/api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/73acaa39-a93f-4c69-9c7e-50f08fb6cde8.webp?width=320 320w, /api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/73acaa39-a93f-4c69-9c7e-50f08fb6cde8.webp?width=350 350w" sizes="100vw" width="350"><img></p><p><h2 id="-">谁参与技术写作，以及如何进行技术写作？</h2></p><p>公司通常有三种方法编写<a href="https://sonat.com/@sonat/articles/who-is-a-technical-writer?lang=en">技术文档</a>，包括用户手册和说明手册。让我们看看哪种方法最好以及如何充分利用每种方法。</p><p><h2 id="1-">1.请技术人员编写用户手册</h2></p><p>许多公司倾向于指派一名或一组技术人员来完成写作工作。这听起来是个聪明的主意。</p><p>这个团队包括产品工程师、开发人员和设计师。他们是父亲，是创造者。所以，他们无所不知（即使不是每个人，也可能是所有人）。总之，他们是主题专家。如果有错误或错误，他们也是最好的参考。 <img class="image-style-align-right" src="/api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/5d5ed74b-d459-477d-b429-68b2287ef8d6.webp" alt="请技术人员编写用户手册" srcset="/api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/5d5ed74b-d459-477d-b429-68b2287ef8d6.webp?width=320 320w, /api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/5d5ed74b-d459-477d-b429-68b2287ef8d6.webp?width=400 400w" sizes="100vw" width="400"></p><p>毕竟，既然最好的资源就在那里，为什么还要费心招聘和支付额外的员工呢？这不是最好的主意，也不是最经济的主意。虽然技术人员是手册的参考之一，但他们不一定是编写培训手册的最佳人选。原因如下：</p><p>首先，他们是优秀的作家吗？许多主要工作是设计和开发产品的技术人员对写作和记录不感兴趣；出于同样的原因，他们没有从事专业写作。他们可能认为自己还有其他紧急的事情要做，考虑到他们的主要任务和职责，这是事实。因此，他们可能不是熟练的作家，也不愿意获得这些技能。但是，如果您的技术人员是优秀的作家或对写作感兴趣，那么您很幸运。不过，这还不是全部。</p><aside class="template-box extra-template-box" variant="extra"><div class="template-box-title">&nbsp;</div><div class="template-box-description"><p>创建专业手册很容易；您唯一需要的就是 Sonat 的<a href="https://sonat.com/templates/">免费用户手册模板</a>。</p></div></aside><p>其次，参与产品技术开发的人员对产品有不同的看法。他们倾向于认为很多信息显而易见，而初次使用的用户肯定需要澄清。他们很可能会陷入这种技术写作陷阱，提供他们认为必不可少但对用户毫无帮助的详细技术信息。</p><p>有些细节对工程师来说很重要，但对普通用户却没有帮助。对用户来说，重要的是技术流程的结果以及它如何满足他们的需求，而不是流程背后的内容。</p><p>手册必须简洁，保留技术细节，同时慷慨地提供说明和警告。主题专家也可能会使用技术词汇和行话，并认为这样做没问题。他们甚至可能会通过引用其他词汇来解释术语，这会造成混淆。</p><h4>使此方法有效的技巧：</h4><p>如果你想让现有的技术人员编写手册，请让整个团队参与进来。这样，你就可以确保应用不同的观点。</p><p><h2 id="-2-">&nbsp;2. 请技术人员编写手册，并请编辑/撰稿人校对。</h2></p><p>流程是这样的。技术人员写好草稿，然后交给编辑/技术作家。这样，写作标准就更有可能得到满足。作家会简化一些部分，用更常用的单词替换行话，统一整体风格，运用一些技巧，让它更有吸引力。</p><p>这种方法听起来好多了。但你能确保编辑们会填补技术人员最初造成的空白吗？他们可能无法猜出所有缺失的部分并改进他们收到的内容。</p><h4>充分利用此方法的技巧：</h4><ul><li>良好的合作可以创造出专业的作品。确保将主题专家（您的技术团队）与作者/编辑联系起来，不要只是要求随机作者编辑没有背景信息的文档。</li><li>确保作者能够经常与技术团队联系，讨论不同部分或提出问题。此外，让技术团队审查编辑后的文档，以确保技术内容已被正确理解和传达。</li></ul><p><h2 id="3-">3. 让技术作家与技术团队密切合作</h2></p><p>聘请技术作家听起来是理想的方法。拥有一名从一开始就编写手册的技术作家，同时有机会与技术团队密切合作，使用、测试和研究产品，这是完美制作用户手册所缺少的要素。强烈建议您聘请一名技术作家来编写手册。主题专家可以在讨论产品的功能和特性时进行审查、评论、解释和编辑。</p><aside class="template-box extra-template-box" variant="extra"><div class="template-box-title">&nbsp;</div><div class="template-box-description"><p>阅读<a href="https://sonat.com/@sonat/articles/top-13-rules-to-create-a-user-manual?lang=en">13 条新规则，为您的企业创建用户手册</a>。</p></div></aside><p><h2 id="-">合作写作是一个魔术。</h2></p><p>在这三种方法中，协作都是写出更好文章的关键。专注于团队合作并提供有效协作空间的文档工具可以促进这一过程。许多在线工具正在努力让这一过程变得更容易。促进合作的方法远不止分享、评论和讨论不同部分的能力。 <img class="image-style-align-right" src="/api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/cc95d994-16ea-469b-8450-b4b09d45067b.webp" alt="合作写作是魔术" srcset="/api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/cc95d994-16ea-469b-8450-b4b09d45067b.webp?width=320 320w, /api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/cc95d994-16ea-469b-8450-b4b09d45067b.webp?width=400 400w" sizes="100vw" width="400"></p><p><a href="https://sonat.com/solution/">Sonat</a>开始越来越注重通过改进工作流程功能来促进协作写作，您可以在其中定义自动化流程。在此过程中。组织中的每个人都可以参与其中，并且可以在应用自动规则的同时分配不同的任务和访问级别；因此，它节省了大量的编辑时间。</p><p>使用 Sonat，您可以避免发布低质量和不受监控的文档，同时为您的编辑和专家节省大量时间。</p><p><a href="https://sonat.com/features/">在此了解有关 Sonat 协作功能的</a>更多信息。</p>