Rédaction d'une documentation

ConseilVoir une présentation vidéo de Dokiel 4.2

Vidéo (chapitrée par thème) proposée par Kelis

Conseil

Quelque soit l'objectif du rédacteur, un ensemble d'éléments doivent être définis au préalable, avant la rédaction :

  • le type de document que l'on souhaite produire, pour quel public,

  • le plan et contenus associés (renvoyant parfois vers l'utilisation d'autres logiciels notamment pour les tutoriels animés),

  • les modalités de diffusion,

  • les acteurs impliqués à chacune des étapes (rédaction, stockage, diffusion).

Conseil

Les documentations produites devront répondre à certain nombre de critères qualité contribuant à leur utilisabilité, leur ergonomie et leur efficacité.