J'ai tendance à trouver XML beaucoup trop verbeux. En particulier, les documents docbook ne sont pas très faciles à lire en texte brut, ce qui reste à mon avis un handicap.
Par ailleurs, à quand j'en avais fait un peu, cela manquait d'éditeur wysiwyg ce qui rend plus difficile l'adoption par le plus grand nombre.
Néanmoins, cette approche présente des avantages vraiment décisifs. Outre la possibilité de générer différents formats, cela permet de considérer les documentations comme de véritables bases documentaires facilement interrogeables avec XSLT par exemple.
Dès lors que la documentation grossit, recouvre diverses applications ou processus, cette possibilité est un avantage très net. Il devient relativement simple d'extraire des parties pertinentes de différentes documentations pour en faire une autre plus pertinente pour un objectif donné (étude ou autre).
Par ailleurs, si les différents éléments (les noms de personnes, codes d'applications et autres) sont bien balisés on peut effectuer des recherches plus efficaces. Par exemple, dans notre SI, une des applis est codée "ET" (si, c'est possible. Le SI est très vieux). Chercher ce genre de motif dans une montagne de documents est un vrai problème. Si c'est balisé , cela n'en est plus un.
# Pratique
Posté par Jice . En réponse au journal DocBook ou l'art d'écrire de la documentation. Évalué à 6.
J'ai tendance à trouver XML beaucoup trop verbeux. En particulier, les documents docbook ne sont pas très faciles à lire en texte brut, ce qui reste à mon avis un handicap.
Par ailleurs, à quand j'en avais fait un peu, cela manquait d'éditeur wysiwyg ce qui rend plus difficile l'adoption par le plus grand nombre.
Néanmoins, cette approche présente des avantages vraiment décisifs. Outre la possibilité de générer différents formats, cela permet de considérer les documentations comme de véritables bases documentaires facilement interrogeables avec XSLT par exemple.
Dès lors que la documentation grossit, recouvre diverses applications ou processus, cette possibilité est un avantage très net. Il devient relativement simple d'extraire des parties pertinentes de différentes documentations pour en faire une autre plus pertinente pour un objectif donné (étude ou autre).
Par ailleurs, si les différents éléments (les noms de personnes, codes d'applications et autres) sont bien balisés on peut effectuer des recherches plus efficaces. Par exemple, dans notre SI, une des applis est codée "ET" (si, c'est possible. Le SI est très vieux). Chercher ce genre de motif dans une montagne de documents est un vrai problème. Si c'est balisé , cela n'en est plus un.