Description
This internship will teach you to prepare, organize and write user guides for applications developed for the company. You will see how to select, organize and present the information to be transmitted as well as the good practices to adopt for the final publication of the document.
Who is this training for ?
For whom ?This course is aimed at anyone who has to write an application user guide, in particular developers and project managers.
Prerequisites
Training objectives
Training program
- Identify the objectives of the guide and ask yourself the right questions
- The basic diagram of communication.
- The specificities of written communication.
- The uses of a user guide.
- The target audience and their level of knowledge.
- Methods of accessing the user guide.
- The tools at our disposal.
- The different possible formats.
- Select the information to transmit
- When to write the user guide?.
- How to determine the information to transmit?.
- How to work with test users?.
- What is the process approach?.
- What is the typology of users?.
- Organize the user guide
- The different possible plans.
- Associate processes by user type.
- Select important processes.
- Use mind maps to organize your ideas.
- Appendices and what to put there.
- Present information in a relevant way
- Use graphics and images.
- Highlight important information.
- Determine the essential, the useful and the accessory.
- How to use the technology at our disposal?. -Include simulations or videos.
- Layout the user guide.
- Write and publish the user guide
- Adapt your vocabulary to your interlocutors.
- Know who you are speaking to.
- Adapt the users' vocabulary.
- Jargon, anglicisms and acronyms: how to avoid them or how to make them understood?.
- The style of the user guide: simple style, short sentences.
- Create tables to make it easier to use 'access to information.
- Where and how to publish?.
- Manage updates.
