Discussion :

[Dams76]

Salut,

Je cherche un logiciel/des infos généralistes sur comment créer des documentations uniformes (pour nos logiciels que l'on développe) sur le plan utilisateur/technique/installation, en gros il faudrait avoir 2 ou 3 DTD et un éditeur sympatoche pour faire tout ca, mais je ne m'y connais pas encore assez en XML et je ne cotois pas assez le monde de l'underground XML

[sequentaire]

Pour l'underground (j'y vais pas) : sparklingPoint. Et cela tombe bien, la prochaine réunion, c'est justement DOCUMENTEZ ! IL EN RESTERA TOUJOURS QUELQUE CHOSE !

[Dams76]

sympa, j'irais jeter un coup d'oeil.

sinon, toi, tu documentes en XML ?

[sequentaire]

Moi ? heu... non... j'utilise javadoc ! (c'est de l'horrible html 3.2, donc).

Néanmoins j'ai commis un jour un petit utilitaire à base d'XML pour garder une trace de tous les mini-développements bidouillesques que je fais, et que j'oublie aussi vite, et qu'il me faut ensuite passer 3 plombes à retrouver. Maintenant, tout va mieux... A condition que je me souvienne où diable à bien pu passer ce petit outil lui même bidoullesque... Il faudra que je pense à le documenter, celui là aussi... Mais pour l'instant, j'ai plus urgent

[Dams76]

bah si kk1 document en XML, qu'il me fasse un signe

[haypo]

T'as qu'à écrire ta propre DTD, ainsi que ton XSL :-) Avant j'utilisais du HTML 3.2 qui pue, maintenant c'est du XML qui me génère un HTML 4 strict bien propre, ou du XHTML, au choix. Pour mes fonctions, la doc ressemble à ça :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
<?xml version="1.0" encoding="iso-8859-1" ?>
<!DOCTYPE fonction PUBLIC "-//HaypoCALC//DTD fonction 1.0//FR"
  "http://www.haypocalc.com/dtd/fonction.dtd">
<fonction>
  <nom>Abs</nom>
  <definition>
    <p>Calcule la valeur absolue d'une expression.</p>
  </definition>
  <exemple>
    <ul>
      <li>Abs(-3) renvoie 3</li>
      <li>Abs(Sin(-x)) renvoie Abs(Sin(x))</li>
    </ul>
  </exemple>
  <propriete>
    <ul>
      <li>Abs(-x) = x</li>
    </ul>
  </propriete>
  <voir>
    <lien type="fonction">Oppose</lien>
    <lien type="fonction">PlusMoins</lien>
    <lien type="fonction">Signe</lien>
  </voir>
</fonction>

Bon, ok, j'ai encore des <ul>, <p> et autres, mais c'est quand même beaucoup plus clair. Avec la validation DTD, je peux interdir certaines balises et attributs ! (en fait, je n'autorise que ce dont j'ai besoin :-)

Sinon LA référence est ... je cherche dans ma mémoire ....
http://www.docbook.org/

@+ Haypo

[haypo]

Le lien que j'ai filé sur Docbook est un trop commercial. Un autre :
http://nis-www.lanl.gov/~rosalia/mydocs/docbook-intro/docbook-intro.html

Pour rappel, docbook permet de générer du HTML, texte, PS (et donc PDF), ou encore RTF à partir d'un unique document source. Le pied non ?

Arf, en fait le premier lien donné contient quand même de bonnes infos, je retire mon premier jugement.

@+ Haypo