Bonjour,

Je développe des produits (j'ai donc plusieurs plateformes hardware) qui utilisent les mêmes libraries logicielles pour la création de leur firmware.

Les produits ont donc du code commun (qui dépend de la version de la library logicielle utilisée) et du code propre au produit.

Pour chaque produit, je dois générer les documents suivants au format pdf :
- une fiche technique
- une notice d'installation
- une notice d'utilisation
- des notes d'applications (optionnel)

Sachant que certains documents peuvent rassembler une famille de produits.

Actuellement, je gère la documentation sous word mais c'est vraiment le bazar : avec les différents copier/coller entre les différents documents, on a toujours des différences de présentation et de contenu pour la description d'une même fonctionnalité car les documents n'ont pas été créés ou mis à jour par la même personne, ou n'ont pas été créés pendant la même période.


Pour uniformiser tout ça, je pensais partir sur une système qui différencie le fond de la forme et donc opter pour faire de la documentation au format HTML. En plus ça permettrait de générer de la documentation intégrable directement sur notre site Web. Je sais qu'il existe des solutions payantes pour faire ça mais elles sont onéreuses (à ma connaissance) et donc pas adaptées pour une PME comme la mienne qui doit générer de la documentation pour une 20aine de produits.

Je pensais donc dans chaque library mettre des documents HTML (un pour chaque type de document à générer) et les images associées décrivant les informations à mettre dans mes différents documents et chaque fichier HTML contiendrait la documentation de toutes les versions de la library. Ensuite pour générer la documentation, je pensais faire appel à un compilateur C (gcc) pour fusionner les différents fichiers via la gestion #include et de #ifdef... c'est possible à faire ? Si oui comment ?


... Peut-être que je pars sur une mauvaise solution pour générer mes fichiers ? Comment gérez vous votre documentation ?

Remarque :
- plusieurs personnes peuvent participer à la rédaction de la documentation, notamment le service marketing qui n'est pas forcement à l'aise avec la manipulation de fichiers HTML.
- on utilise Git, ça devrait donc être suffisant pour pouvoir gérer la modification d'un même fichier par plusieurs personnes.

Merci d'avance,