Idéalement, j'aimerai bien avoir ça côté versionning :
la doc et le logiciel sont versionné séparément (je ne parle pas de gestion de version via git ou autre)
chaque version de la doc est associée à un ensemble de version du logiciel
quand tu mets à jour la doc (correction, clarification, etc...), tu bump sa version, pas de soucis
quand tu mets à jour le logiciel, et que cela n'impacte pas la doc, en réalité si, ça l'impacte : l'ensemble de version compatible est modifié
En gros, dès que tu modifie le logiciel, la doc s'en retrouve impactée, dans tout les cas.
Et du coup côté procédure :
une seule procédure pour générer la doc, qui est déclenchée par un build (en général déclenché par une git hook en même tant que l'intégration continue, voir le déploiement continu)
la doc et le logiciel dans le même dépôt, ou alors un git-submodule pour ne pas perturber les rédacteurs/traducteurs, une mise à jour de la doc implique un nouveau trigger de la git hook
Mais en réalité ce que je fais vraiment c'est plutôt :
j'ai la doc dans le même dépôt que mon logiciel
doc d'API générée par les docstrings de mon code, et 2-3 tutos que je mets à jour à chaque version majeure si besoin
ma doc et mon logiciel ont le même numéro de version (l'utilisateur à pas à se casser la tête, logiciel version X.Y.Z, doc version X.Y.Z)
# Mon grain de sel
Posté par David Delassus (site web personnel) . En réponse au journal Documentation pour un logiciel même version que le logiciel ?. Évalué à 2.
Idéalement, j'aimerai bien avoir ça côté versionning :
En gros, dès que tu modifie le logiciel, la doc s'en retrouve impactée, dans tout les cas.
Et du coup côté procédure :
Mais en réalité ce que je fais vraiment c'est plutôt :
https://link-society.com - https://kubirds.com - https://github.com/link-society/flowg