Plan du cours
Introduction
- Créer Documentation qui sera utilisé
Recueil des besoins
- Comment regarder un manuel d'instruction du point de vue de l'utilisateur
- Recueillir et comprendre les exigences (internes et externes)
- Ce qu'il faut inclure dans le document technique Documentation et ce qu'il faut en exclure
Planification
- Planification d'un projet de rédaction technique
- Les calendriers et le cycle de vie des produits
Rédaction
- Rédiger une version minimale viable
- Rendre vos écrits compréhensibles
- L'importance de l'itération dans le processus d'écriture
Structuration
- Structurer un document
- Rendre le contenu Searchable
Apparence
- Ajout d'illustrations et de diagrammes
- Techniques de formatage et de mise en page
- Utiliser la typographie pour améliorer la lisibilité
Outils
- Utilisation d'outils et de modèles techniques Documentation
Révision
- Optimiser le flux de travail technique Documentation
- Formaliser le processus d'examen et de révision
Traduction
- La traduction et le processus de traduction
Édition
- Publication d'un document technique
Post-publication
- Obtenir un retour d'information de la part des utilisateurs
- Mise à jour et maintenance technique Documentation
Résumé et conclusion
Pré requis
- Aucune exigence particulière autre que celle d'avoir un produit ou un service qui nécessite une documentation technique.
Audience
- Non rédacteurs (par exemple, développeurs, ingénieurs, responsables techniques, concepteurs, chefs de produit et de projet, etc.
Nos Clients témoignent (6)
Capacité du formateur à écouter et à comprendre mon cas/question/problème...
Francois - TE
Formation - Technical Architecture and Patterns
Traduction automatique
I am getting the correct level of understanding I need to assist in my day to day work
Wasfi Adams
Formation - Impacted Function Point (IFP)
Everything was built up from a basic level while progressing quick enough to prevent anyone getting bored.
Nathan Roberts
Formation - Software Engineering
The trainer was super engaging and made sure we understand through questioning and affirmations. Even though the content was overwhelming, the trainer broke it down well and made content easily accessible for later reference.
Zaid Amerika
Formation - Unit of Software Measurement Parameterization (UMSP)
the examples the trainer used in each subject which made it easier to understand
huda Alyassi - Dubai Government Human Resources Dept.
Formation - Adobe XD
Le formateur était vraiment gentil et bien informé, il a fait un effort supplémentaire pour m'expliquer des choses que je ne connaissais pas.
Felix - Microchip Technology Inc
Formation - Embedded C Application Design Principles for Automotive Professionals
Traduction automatique