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.
 14 heures

Nombre de participants



Prix par participant

Nos Clients témoignent (5)

Cours Similaires

Software Engineering

35 heures

The Principal Engineer - Masterclass

14 heures

SNAP IFPUG Software Size Estimation and Measurement

14 heures

Impacted Function Point (IFP)

7 heures

Unit of Software Measurement Parameterization (UMSP)

7 heures

FlexNet Publisher Fundamentals

14 heures

AI-Augmented Software Engineering (AIASE)

14 heures

AI Coding Assistants: Enhancing Developer Productivity

7 heures

OCUP2 UML Certification - Preparing for the UML2 Intermediate exam.

14 heures

OCUP2 UML Certification - UML2 Advanced Exam Preparation

14 heures

Embedded C Application Design Principles for Automotive Professionals

14 heures

Technical Architecture and Patterns

21 heures

Embedded C Application Design Principles

14 heures

Model Based Development for Embedded Systems

21 heures

Architecture and Design: Core + Advanced Training

42 heures

Catégories Similaires