Écrire de la documentation portable

Portable?

La documentation "portable" est une documentation qui doit être disponible dans une grande variété de formats. IL n'est bien sur pas question de modifier tous ces formats "à la main", il faut donc un format source et des backends, programmes transformant le source en documents utilisables.

Sgml

Le SGML est une façon d'écrire les instructions de mise en forme directement dans un fichier texte, sous forme de "balises" ("tag" en anglais).

Le format html des pages web est un exemple de code Sgml. Le "XML" en est un autre exemple.

Linuxdoc

Linuxdoc est un format donné en référence au projet Linuxdoc, la documentation Linux de référence, celle qui gère les HOWTO.

C'est une variante de sgml très simple, facile à écrire même avec Vi.

Docbook

Il s'agit d'une variante de sgml bien plus puissante que Linuxdoc, mais avec des balises plus complexes.

LyX

LyX est un petit (par la taille du projet) traitement de texte. A l'origine c'était une interface graphique à LaTeX, parfaitement capable d'écrire des mémoires de thèse scientifiques de centaines de pages sans nécessiter l'apprentissage de laTeX.

Il est aussi devenu un moyen très confortable d'écrire des manuels Sgml, en Docbook ou en Linuxdoc.