Hi again~
Finally I get an idea to post about it documentation. After being so occupied to the documents, phew~
This time I’ll try to share about the difference between SOP documentation and user guide documentation. This posting maybe seems unuseful but I believe that there still are some of us who still don’t fully understand yet about the difference between SOP and user guide documentations.
As the document’s name depict, SOP is the document which describes the standard procedure in doing something, in this term, using some functionalities available in a project. It’ll serve you as a guide so you won’t meet any difficulties in using the functionalities later. You’ll find the steps to do something in SOP, and the picture of application screen shoot following the action that you do based on the step. SOP tells you to do the right steps so later you’ll get the supposed respond from the application. Hence, SOP document will only consists of the steps in using available functionalities in an application. You won’t find any detail description of the functionalities available. SOP for similar functionalities should differ depend on the role who uses the application, hence if you have role as administrator and your friend has role as staff, SOP document that both of you accept will be different. Imagine if your companies have employee management application. You act as one of HR executive, while one of your friend, let’s called her A, works as an employee. As HR executive, you can manage all employees data, including payment, position, etc. While A as an employee, can only manage her own personal data. Thus, SOP for both of you should be different.
Let’s move on to the next topic, user guide documentation. As the name’s depict, user guide documentation describes the complete guide to the user of the application. Because it is the complete version guide of an application, there should also steps in using functionalities. Thus, user guide documentation consists of SOP, glossary of an application, complete description of available functionalities in an application. Different from SOP, user guide consists of functionalities available for each roles, that’s why several SOP can be a user guide. User guide documentation will also describes about the failure options of available functionality, and any other possible scenarios for each functionality.
Then, when should we use SOP and when should we use user guide? I think the answer will depend on the requirements of the application. In my point of view, SOP will be enough for smaller application, while user guide will be necessary for larger and wider application.
I think that’s it for now, I’ll update the post if there’s something came up to my mind later~
Cha ^^