Overview: In today’s world, creating an attractive documents for the end user’s perspective is the basic need for the company. User manual plays an important role to fulfill this gap. The user is intelligent but uninformed; hence, user manual is the fortified medium to provide thorough information about the process. As per the client’s requirement, the updated latest changes should be maintained for the end user’s perspective. It is necessary to maintain various version to update with a glimpse in the revision history. Creating user friendly table of contents, references, indexing, appendices etc. are another important part. By reading the following points get clear your idea –
Organisation Requirements –
Before proceeding your documentation work, make sure about the project requirements from the project coordinator, SME’s, QA-Lead, Team leader etc. Demand for a proper knowledge transfer session and also ask for the requirement documents. This helps to create a rough idea and also apply strategies yourself brainstorm and tree. Make a rough flowchart in Microsoft MS Visio, it helps to understand the project flow. Ensure the document template of your company preferably used, the font size, header & footer, company’s logo etc.
Making Questionnaire –
During the knowledge transfer session use your active listening skills. Make sure, the difference between hearing and listening. Hearing is the perception of sound, whereas listening is attention to what is being said. Prepare yourself to ask the open-ended questions rather than yes or no type. These types of questions starts with how, what, why etc. It might happens that Subject Matter Expert get off-track in between the KT session. It is your responsibility to make him on the track so that you will get relevant information. Collect information from concern developer, tester, or QA-Lead; so that it helps you to complete your task.
Follow the document development life cycle (DDLC) –
Make sure about the DDLC checklist, this helps you the scope of the project. The DDLC stands for 4 D’s i.e. define, design, development, and deliver. Arrange the pre-engagement meeting with the SMEs for gathering the necessary data. Implement the Waterfall method to complete your assigned task. The Waterfall method completely follows the DDLC process as given below –
Figure 1 – Shows DDLC Process
Make a rough draft. For example, determine the audience and their goals, basic facts, strategy, tone, outline/page format/visual aids and finally production schedule.
Make a final draft of your work – apply strategies and style of your organisation, apply strategies to help yourself brainstorm & make tree, revise to help readers, comprehension.