How to Write Standard Operating Procedures?

如何编写标准的操作程序?

2021-03-24 17:00 clickhelp

本文共1176个字,阅读需12分钟

阅读模式 切换至中文

Standard operating procedures, or SOPs, are documents that contain a set of instructions on how to perform a task in a correct and safe way according to all the regulations. This type of technical documentation is equally important not only for new companies that are just establishing their processes but also for those who have been working for a long time. In the majority of spheres, it is vital to have standard guidelines telling employees how to work. To understand the value of an SOP, let’s figure out what benefits it gives: Compliance with standards. All employees will have the same knowledge and use the same standards. That means a lot when we talk about the quality and efficiency of work and reduction of errors, and it contributes to the consistency of workflow in general. Safety. Instructions provide the safest ways of fulfilling tasks and, of course, producing safe products. Quick onboarding. Another question of great importance. Newbies need not only a tutor but a set of instructions as a source of information. Scheduling. You can specify when and what should be done to avoid slowing down the workflow pace. Writing an SOP: Best Practices How to write a useful SOP from scratch? It is not a difficult task if you follow simple steps. Actually, the same steps may help you update the existing SOPs. So, what you are to do: Define what processes need to be documented and how they are going to be interrelated. Not all processes that take place in a company require being documented. Only the ones that have significance. And, if they are somehow connected, show it, including references or links to each other. This can help different departments cooperate more efficiently. Define the end result. You don’t need to specify all the details. It is just what you want to achieve and what problems you want to solve. Define the format. If you already have some SOPs, you can go on using the same format. If you work for a large international company, most probably you are to use ISO 9000. In other cases, you are to choose what is going to work better for your company and your workflow, and you are not obliged to use international standards. For small teams and processes that do not require details, you can use checklists. Some processes can be described well in the format of steps. And, of course, one can use flowcharts. They are great to demonstrate hierarchical structures and interrelations among the items. Define the end-users. That is an essential step in the process of document creation. It means the document should be focused on the duties and responsibilities of end-users. When you know your target audience, you use the right terminology, give the right amount of information - no excessive explanations, and add corresponding visual content. Our post - Targeting of Technical Documentation will tell you more about that. Define the creators. To create a useful and informative SOP, a technical writer should consult with those who deal with the process described every day. It is better to attract experts from different levels. Those at higher levels are more concentrated on the purpose and are less likely to be involved in the process itself. Experts at lower levels are more involved in the routine. You are to find balance. Define the scope. You are to know exactly the beginning and the end of your procedure not to mix it up with other procedures and processes. Define the metrics. Metrics are used to measure the quality of the process. You can see if your SOP is efficient enough and if not - what are the weak points. You can measure time spent on completing a task or the amount of resources. These are the essential preparation steps. When you are done with them, you are ready to go further - to work on an SOP structure. Let’s talk about that. What Should an SOP Contain? The majority of SOPs contain the following structural and logical elements: Title page. It includes not only the name of the process or procedure but also the identification number, publication date, company’s or department’s name, authors’ names. Title pages are common for printed documentation. Online documentation doesn’t have a title page. In topic-based systems, like ClickHelp, for example, the first topic in the table of contents can be used as a title page. Table of contents (TOC). Actually, you need it for a substantial document. If your SOP is a checklist, you don’t need it. Introduction. This part describes the process in general and the scope of problems that are going to be solved. Body. These are instructions and procedures. Apart from that, this element may contain clarification of terminology, safety warnings, equipment, supplies, etc. Attachments. Reference materials, notes, internal knowledge base articles, forms, contact information, etc. Of course, this list may differ from document to document, but the idea will still remain the same. Creating an SOP in ClickHelp ClickHelp is a feature-rich cloud platform that may become a great solution for creating and publishing internal SOPs. The main advantages of using an online documentation tool are: Great environment for collaboration. Several authors may work on a document and easily review it, leaving comments. ClickHelp is an online browser-based tool, so all team members have a mutual environment for work. You won’t lose sight of any updates, which is not an easy task if several authors work on the same document and several experts review it. Where is the last version? Don’t worry, you won’t lose it. Ability to reuse content. If you are working on SOPs for several departments in a company, some information is going to be the same from document to document. You can create reusable pieces of content like variables and snippets. Analytics and reporting. It is not only about the readiness of the document but also about user feedback. They can vote if your SOP is useful and leave comments. It is an amazing opportunity to track soft spots and improve them. Ability to use infographics, videos, flowcharts, diagrams, etc. ClickHelp allows using interactive content. We have great posts about that - Using Diagrams in IT Documentation: Best Practices, Latest Tips on Using Video Content in Technical Documentation. Available information. Using online documentation tools allows you to create documentation that is available 24/7 from any place: you can use your laptop or smartphone to read it. What you need is the Internet. Conclusion Documenting daily routine and other business processes ensures that your team always has a reliable source of information at hand. Even the most talented or experienced employees are not as effective as when they have comprehensive guidelines. Some businesses benefit from using standard operating procedures templates: laboratories, IT companies, HR, restaurants, pharmaceutical companies, etc. What really matters is how to make the information accessible at any time and from any device. Good luck with your technical writing! ClickHelp Team Author, host and deliver documentation across platforms and devices
标准操作程序(SOP)是一种包含一组说明的文件,内容是关于如何根据所有法规以正确和安全的方式执行任务。这种类型的技术文档不仅对刚刚建立流程的新公司重要,而且对那些已经工作了很长时间的公司都同样重要。在大多数领域,有标准的指导方针告诉员工如何工作是至关重要的。 为了理解SOP的价值,让我们看看它有什么优点: 符合标准。所有员工将拥有相同的知识和使用相同的标准。这意味着当我们谈论工作的质量和效率以及减少错误时,它有助于工作流的一致性。 安全。说明书提供了完成任务的最安全的方法,当然,也提供了生产安全产品的方法。 快速入职。另一个非常重要的问题。新手不仅需要一个导师,还需要一套指导方法作为信息来源。 行程安排。您可以指定何时去做,以及应该做什么来避免减慢工作流的速度。 编写SOP:最佳实践 如何编写一个有用的SOP?只要你遵循简单的步骤,这就不会是一项困难的任务。实际上,同样的步骤可以帮助您更新现有的SOP。所以,你要做的是: 定义需要记录哪些流程,以及它们将如何相互关联。并非所有在公司中发生的过程都需要记录下来。只有那些有意义的。如果它们是某种方式连接的,那么就显示出来,包括相互引用或链接。这可以帮助不同部门更有效地合作。 定义最终结果。您不需要指定所有详细信息。这就是你想要达到的目标和你想要解决的问题。 定义格式。如果你已经有一些标准作业程序,你可以继续使用相同的格式。如果你在一家大型跨国公司工作,你很可能会使用ISO9000。在其他情况下,你要选择什么对你的公司和你的工作流程更有效,你没有义务使用国际标准。对于不需要详细信息的小型团队和流程,可以使用检查表。有些过程可以用步骤的形式很好地描述。当然,也可以使用流程图。它们很好地展示了项目之间的层次结构和相互关系。 定义最终用户。这是文档创建过程中必不可少的一步。这意味着该文件应侧重于最终用户的职责和责任。当你了解你的目标受众时,你要使用正确的术语,给出正确的信息量——不要过度解释,并添加相应的视觉内容。我们的技术文档后定位将告诉你更多关于这一点。 定义创建者。为了创建一个有用且信息丰富的SOP,技术作者应该咨询那些每天处理所描述过程的人。最好吸引不同层次的专家。更高级别的人更专注于目标,不太可能参与过程本身。下级专家更多地参与日常工作。你要找到平衡。 定义范围。你要准确地知道你的程序的开始和结束,不要把它和其他程序和过程混在一起。 定义指标。度量标准用于度量流程的质量。你可以看看你的SOP是否足够有效,如果不够-有什么弱点。您可以测量完成任务所花费的时间或资源量。 这些是必要的准备步骤。当你完成了这些任务后,你就准备进一步研究SOP结构了。我们谈谈。 SOP应该包含什么? 大多数标准作业程序包含以下结构和逻辑要素: 标题页。它不仅包括过程或程序的名称,还包括识别号、出版日期、公司或部门名称、作者姓名。标题页是打印文档的常用页。联机文档没有标题页。在基于主题的系统中,例如ClickHelp,目录中的第一个主题可以用作标题页。 目录(TOC)。实际上,你需要它来做一份实质性的文件。如果你的SOP是一个清单,你不需要它。 导言。这一部分描述了一般过程和将要解决的问题的范围。 正文。这些是说明和程序。除此之外,该要素可能包含术语、安全警告、设备、供应品等的澄清。 附件。参考资料,笔记,内部知识库文章,表格,联系方式等。 当然,这份清单可能会因文件而异,但想法仍然是一样的。 在ClickHelp中创建SOP ClickHelp是一个功能丰富的云平台,它可能成为创建和发布内部SOP的一个很好的解决方案。 使用在线文档工具的主要优点是: 良好的合作环境。几位作者可能会处理一个文档并轻松地审阅它,留下评论。ClickHelp是一个基于浏览器的在线工具,因此所有团队成员都有一个共同的工作环境。您不会忽略任何更新,如果多个作者处理同一个文档,而多个专家对其进行审阅,那么这并不是一项容易的任务。最后的版本在哪里?别担心,你不会输的。 能够重用内容。如果你正在为一个公司的几个部门制定标准作业程序,那么在不同的文档中,有些信息是相同的。您可以创建可重用的内容片段,如变量和代码段。 分析和报告。这不仅关系到文档的准备情况,还关系到用户的反馈。他们可以投票,如果你的SOP是有用的,并留下评论。这是一个很好的机会来追踪弱点并加以改善。 能够使用信息图表、视频、流程图、图表等。ClickHelp允许使用交互式内容。关于这一点,我们有很好的帖子——在IT文档中使用图表:最佳实践,在技术文档中使用视频内容的最新提示。 可用信息。使用在线文档工具,您可以在任何地方创建全天候可用的文档:您可以使用笔记本电脑或智能手机阅读。你需要的是互联网。 结论 记录日常事务和其他业务流程可确保您的团队随时掌握可靠的信息来源。即使是最有才华或经验的员工也不如他们有全面的指导方针时有效。一些企业受益于使用标准操作程序模板:实验室、IT公司、人力资源、餐厅、制药公司等。真正重要的是如何使信息在任何时间和任何设备上都可访问。 祝你好运! ClickHelp Team 跨平台和设备编写,查验和交付文档

以上中文文本为机器翻译,存在不同程度偏差和错误,请理解并参考英文原文阅读。

阅读原文