Odoo 701: How to Template for urock Module Text

How to Write a Good “How To” for Systemology

This document will help you write good text for your System Capture. If you follow this template, the results of the training you are creating will increase in success for the students. 

Title: This should be the same as the Module name in "0 Systemology Plan"

• Clear and concise: Briefly state the task or skill you're teaching. (Eg. Creating a Sales Order)

• Action-oriented: Use verbs to encourage action (e.g., "Set Up Your New Printer" or "Troubleshoot Common Login Issues").

• Targeted keywords: Include relevant keywords that users might search for (if applicable).

Introduction: This should be the same as the Description box in "0 Systemology Plan"

• Hook: Briefly grab the reader's attention and explain why this how-to guide is valuable.  (Eg. In this how to we will cover the best way to create a sales order that will provide quick and effective customer service.)

• Target audience: Specify who this guide is intended for (E.g. beginners or existing customers).

• Estimated time: If applicable, include the time it should take to complete the training.

Body:

• Step-by-step instructions:

• Break down the process into clear and concise steps, numbered for easy following.  Remember to write as if you are speaking to the person reading.  The numbering should be in the format of 1.2.1 etc. Not 1.a.2.a

• Use simple language and avoid technical jargon (unless defining it within the guide).

• Include visuals (screenshots, diagrams) to enhance understanding for complex steps.  Ensure your steps line up with your visuals.

• Tips and tricks: Offer helpful hints or shortcuts to make the process easier or more efficient.

• Troubleshooting:  Anticipate common problems and provide solutions.

• Additional resources:  Link to relevant articles, videos, or FAQs for further information.

Conclusion:

• Summary: Briefly recap the key steps.

• Call to action: Encourage the reader to take the next step (e.g., contact customer support, try the skill, leave a comment).

• Contact information: Provide contact details for further assistance (optional).

Formatting:

• Use numbered lists for easy-to-follow steps.

• Bold key terms or important information.

• Maintain a consistent and professional tone.

• Proofread carefully for any errors.

• Have a clickable table of contents or headers for ease of navigation

Additional Tips:

• Consider your audience's level of knowledge.  If your module is for beginners then your steps should be detailed and contain many visuals for guidance.  

• Assume your audience knows much less than you and you are teaching from base one. 

• Break down complex tasks into smaller, manageable steps.

• Use visuals strategically to enhance understanding.  

• Maintain a positive and encouraging tone ensuring your how to reads as though you are speaking to the reader.

• Test the guide with your target audience and refine it based on feedback. (Send it to a reviewer!)