Sonat

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

Articles

V1.0.0

内部、外部、产品、流程、技术和用户文档

<h1>内部、外部、产品、流程、技术和用户文档</h1>您是否总是需要澄清涉及不同类型文档的许多术语？请查看以下问题。手册和用户文档是什么意思？什么是用户手册？编写用户手册算不算技术文档？培训手册和说明手册有什么区别？外部和内部文档？产品和流程文档？在这里，我们将以最合理的方式对所有这些相关术语进行分类和定义，以便您了解它们的相似之处和不同之处。但是，文档术语可以互换使用；我们也会介绍它们。所以，让我们从定义这个主题中最通用的术语开始：<aside class="template-box extra-template-box" variant="extra"><div class="template-box-title">&nbsp;</div><div class="template-box-description">获取有关<a href="https://sonat.com/@sonat/articles/what-exactly-is-a-user-manual-and-why-is-it-so-important-?lang=en">用户手册对贵公司的重要性的</a>更多信息。</div></aside>&nbsp;<h2 id="-">文档</h2>&nbsp;文档是一种可传达的材料，它正式提供有关系统、产品、服务、组织、程序或技术流程的介绍、描述、培训和指导的信息。在许多情况下，这些正式的信息性文件也称为手册。让我们进入下一个级别。在讨论产品或服务时，良好的分类可以将文档或手册分为两大类：技术文档和用户文档。另一个类别可能将文档分为产品文档和流程文档，类似于第一个类别。对文档进行分类的另一种合理方法，尤其是关于组织设置的方法，是根据内部或外部来组织文档。我们将对所有这些问题进行讨论，并从最广泛的问题开始。<h3>外部文档<img class="image-style-align-right" src="/api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/b7d147a6-9112-4fa8-979a-c118c53c9d9d.webp" alt="外部文档" srcset="/api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/b7d147a6-9112-4fa8-979a-c118c53c9d9d.webp?width=320 320w, /api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/b7d147a6-9112-4fa8-979a-c118c53c9d9d.webp?width=350 350w" sizes="100vw" width="350"></h3>从名称上就可以看出，外部文档旨在与组织（公司、业务部门等）外部的人员共享，以提供有关产品或服务的信息和指南。因此，外部文档也可以称为产品文档。公司的外部/产品文档可以分为用户文档和系统文档。<h4 style="text-align:justify;">A. 用户文档</h4>用户文档，也称为最终用户文档，旨在为最终用户提供有关产品或服务的全面信息。此类文档也可称为用户帮助。其主要目的是为用户提供有关产品的有用信息，例如一般介绍、描述其功能以及安装、使用和维护说明。这一类手册通过一些技术解释来教授主题。不过，由于目标是最终用户，它们必须限制详细的技术信息，并使用简单的语言和标准术语和表达，而不是技术术语。因此，它们提供了用户友好的指南和分步说明以供实际使用。因此，虽然用户文档属于<a href="https://sonat.com/@sonat/articles/who-is-a-technical-writer?lang=en">技术作家</a>（使用技术信息、理解技术信息并将其翻译成更简短、更简单的内容供最终用户使用）的范畴，但它并不总是被视为技术文档。因为它们通常不针对专家和专业人士。我们将在本文后面讨论技术文档。<aside class="template-box extra-template-box" variant="extra"><div class="template-box-title">&nbsp;</div><div class="template-box-description">使用<a href="https://sonat.com/features/">Sonat 的免费用户手册模板</a>创建用户手册的方法出奇的简单。</div></aside>让我们回顾一下不同形式的用户文档：<ul><li>安装和设置手册<ul><li>安装和设置手册包含有关安装、设置和启动产品的详细信息。</li></ul></li><li>使用说明书<ul><li>指导用户如何正确使用产品的手册。</li></ul></li><li>故障排除手册<ul><li>解决如何解决产品常见问题的手册。</li></ul></li><li>用户手册<ul><li>典型的用户手册通常将上述所有指南集中在一起。用户手册针对不同的用户（包括熟练用户和非熟练用户），提供有关产品设置、操作和维护的说明。它们向用户介绍产品并概述其标准功能及其不同特性和应用程序。它们通常包括有关使用产品的注意事项，也可能包括基本的常见问题解答和故障排除。</li></ul></li></ul>&nbsp;<h4 style="text-align:justify;">B. 系统文档<img class="image-style-align-right" src="/api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/e8b3fdd5-e39f-46cf-ae19-729b487a0572.webp" alt="系统文档" srcset="/api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/e8b3fdd5-e39f-46cf-ae19-729b487a0572.webp?width=320 320w, /api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/e8b3fdd5-e39f-46cf-ae19-729b487a0572.webp?width=400 400w" sizes="100vw" width="400"></h4>系统文档可能以服务手册或维修手册的形式出现。系统文档包括底层系统概述、更详细的技术信息和维修说明，以帮助机械师、工程师和其他高级用户维修产品。<h3 style="text-align:justify;">&nbsp;</h3><h3 style="text-align:justify;">&nbsp;</h3><h3 style="text-align:justify;">&nbsp;</h3><h3 style="text-align:justify;">&nbsp;</h3><h3 style="text-align:justify;">内部文件</h3>内部文档不是为了对外共享。它包括技术细节和组织政策、程序等，这些对于用户来说是不必要的或没有用的。通常，此类文档可作为员工、技术团队、经理或其他办公室工作人员的参考，以更高效地完成工作。如上所述，内部文档可分为技术/流程文档和组织支持文档。&nbsp;<h4 style="text-align:justify;">A. 技术文档</h4>当我们使用术语“<a href="https://sonat.com/@sonat/articles/who-is-a-technical-writer?lang=en">技术文档”</a>时，我们指的是主要在组织的技术团队中分发的内部文档。它们涵盖测试计划、开发流程、设计规范、项目计划、系统维护和改进等主题，以及许多技术术语。术语“流程文档”几乎指的是同一种文档。技术文档和流程文档可以互换使用。&nbsp;<h4 style="text-align:justify;">B. 组织支持文档</h4>在任何组织中，都有不同的手册和文档用于培训员工和定义内部组织准则，并且大多数这些文档都属于<a href="https://resources.workable.com/hr-manager-job-description">人力资源领域</a>。让我们讨论一下您在组织中遇到的一些最常见的手册相关术语：1.操作手册：该手册包含公司的标准和指南，概述了应该做什么和如何做。因此，它可以帮助员工更正确、更有效地完成工作，特别是在商品和服务的质量和安全方面。2.危机管理手册：它是指导员工如何应对工作场所危机的手册。3.审计手册：它描述了公司的审计政策和程序。4.培训手册：培训手册主要用于改进所执行的任务，并可能包括培训员工的指导。培训手册可作为初学者和熟悉/有经验的员工的参考指南。<aside class="template-box extra-template-box" variant="extra"><div class="template-box-title">&nbsp;</div><div class="template-box-description">阅读<a href="https://sonat.com/@sonat/articles/top-13-rules-to-create-a-user-manual?lang=en">13 条经过验证的规则，轻松创建您的用户手册</a>。</div></aside>5.政策手册：政策手册或政策和程序手册通常是经理和主管的良好参考资料，可帮助他们做出决策并有效经营业务。它包含所有公司指南、规则和政策，以及遵循这些政策和标准的具体程序。6.组织手册：它定义了组织结构，包括有关组织职位、任务、职责、职位描述、责任、关系和层次结构的所有信息。因此，它可以帮助员工更好地了解和履行自己的工作职责。&nbsp;<h2 id="-">指南</h2>&nbsp;那么，什么是指南？与我们讨论的手册术语相比，指南是一个更通用的术语，指任何带有指南和帮助的手册。指南不一定是关于使用产品的。用户指南不必全面，可以像卡片一样简单，为用户提供一些有用的说明。&nbsp;&nbsp;<aside class="template-box note-template-box" variant="note"><div class="template-box-title">&nbsp;</div><div class="template-box-description">用户指南、用户说明、用户说明手册和用户手册这些术语经常互换使用，因为它们的主要目的是帮助正确使用产品。</div></aside>&nbsp;<h2 id="-">结论</h2>&nbsp;组织的文档可以用不同的方法进行分类。一种方法是决定哪些文档将在外部共享，哪些不会。详细的技术和公司政策和程序不打算在外部人员之间传播。另一方面，系统和用户文档可以帮助用户根据需要了解公司的产品。那么，让我们快速回顾一下要点：<figure class="image"><img src="/api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/5d3c8c6a-39d6-4cb3-bf5a-95e41930cbdc.webp" alt="文档分类" srcset="/api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/5d3c8c6a-39d6-4cb3-bf5a-95e41930cbdc.webp?width=320 320w, /api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/5d3c8c6a-39d6-4cb3-bf5a-95e41930cbdc.webp?width=640 640w, /api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/5d3c8c6a-39d6-4cb3-bf5a-95e41930cbdc.webp?width=800 800w" sizes="100vw" width="800"></figure>&nbsp;<figure class="table"><table><thead><tr><th colspan="4">文档：正式的描述性信息文档</th></tr></thead><tbody><tr><td colspan="2">内部文档：针对组织内部的人员，包括技术人员和办公室人员。</td><td colspan="2">外部/产品文档：针对用户和外部人员</td></tr><tr><td>技术/流程文档：包括与技术团队内部共享的项目和测试计划、设计和开发。</td><td>组织支持文档：公司的政策、程序、标准、组织结构图和培训材料。</td><td>用户文档：针对最终用户；最常见的形式是用户手册。</td><td>系统文档：针对高级用户（工程师和维护人员）</td></tr></tbody></table></figure>用户文档主要包括以下内容：<ul><li>使用说明书</li><li>安装手册</li><li>故障排除手册</li><li>用户手册</li></ul>用户文档目标是：帮助用户了解产品以及如何：<ul><li>安装</li><li>操作</li><li>故障排除</li><li>让用户远离可能的危险</li></ul>技术文档主要涵盖：<ul><li>测试计划</li><li>技术设计规范</li><li>项目计划</li></ul>技术文档目标是：保存组织的技术流程和入职技术人员的记录，以便：<ul><li>发展</li><li>测试</li><li>维护</li><li>改进</li></ul><aside class="template-box extra-template-box" variant="extra"><div class="template-box-title">&nbsp;</div><div class="template-box-description">100% 保证，100% 免费的用户手册模板将帮助您从头开始编写手册。<a href="https://editor.sonat.com/auth/signup">注册</a>&nbsp;并<a href="https://sonat.com/@sonat/articles/free-user-manual-template?lang=en">使用免费的用户手册模板编写专业手册</a>。</div></aside>