La documentation interne au logiciel est écrite par les développeurs dans ou autour du code source. Vous pouvez réduire le temps alloué à la rédaction si vous écrivez la documentation utilisateur au même moment que la documentation interne du logiciel. Mais personne ne veut l’entendre ou le croire.

Néanmoins, beaucoup d’informations peuvent être partagées entre ces deux formes de documentation. Même si vous ne souhaitez pas partager l’information entre les documents, ou que cela vous semble inapproprié, des sujets que vous identifiez dans un document peuvent vous orienter sur l’ajout d’informations complémentaires dans un autre.

Un exemple

Dans le cas d’un développement en méthode Agile, vous écrivez surement des stories. Souvent, elles reflètent des cas d’utilisation. Ce type de stories peut être utilisé comme base pour la documentation utilisateur, à moins que le développement ne prenne le mauvais chemin. Dans les cas de scenarios de tests, ces derniers peuvent s’intégrer dans la documentation, ou au moins servir de source d’inspiration.

Il faut ensuite réduire le fossé qui existe entre le cycle de développement et le cycle documentaire.

Cela veut dire que les gens doivent partager.