01 61 08 50 20Documentation logicielle et aide en ligne
| Objectif | Maîtriser les règles et les principes de la rédaction pour documenter un logiciel |
| Durée | 2 jours |
| Profil | Rédacteurs |
| Pré-requis | Aucun |
Pour qui et pour quoi écrire ?
- Objectif d’une documentation de logiciel
- Public
- Pré-requis
Formats à privilégier
- Aide en ligne
- HTML
- Captures d’écran aux formats GIF ou JPEG : quels outils, quand utiliser une capture d’écran ?
Conception d’une documentation de logiciel
- Données d’entrée :
- Spécifications fonctionnelles
- Logiciel à documenter
- Validation de la documentation :
- Validation technique
- Validation rédactionnelle
- Tests utilisateurs
- Tests d’intégration pour les aides en ligne
- Maintenir une documentation à jour :
- Importance de l’historique d’un document
- Rapports développeurs / rédacteurs
Conception d’une aide en ligne
- Principe
- Aide en ligne contextuelle
- Synchronisation avec les développeurs
Travaux pratiques
- Etude de cas : documentation d’un logiciel
| Next > |
|---|