[Linux-bruxelles] Format de documentation technique

[Laurent Léonard]

Sébastien Adam a écrit :
> Bonjour à tous,
> 
> Le responsable du service (informatique) dans lequel je travaille a
> décider de nous orienter vers l'open-source plutôt que vers les
> logiciels propriétaires. C'est, je pense, un très bonne chose, même si
> les raisons sont plus économiques que philosophique. Mais bon, on ne
> va pas chicaner (<troll>on n'est pas vendredi ;-p</troll>)
> 
> Un de nos gros problème, c'est la documentation de ce nous produisons.
> En effet, elle est quasi inexistante, mais bon ce n'est pas vraiment
> une question de mauvaise volonté ou quelque chose du genre, mais plus
> un manque de temps.
> 
> Je voudrais proposer quelque chose d'efficace qui permette d'avoir un
> présentation identique de tous les documents, et indépendante du
> document lui-même, un peu comme le DocBook.
> 
> Malheureusement, il y a des contraintes:
> - cela doit être très facile et rapide à rédiger (nous n'avons pas
> toujours le temps de le faire), pourvoir contenir des images, des
> citations, des lignes de commandes, etc...
> - cela doit être facilement et rapidement lisible, la présentation
> doit être gérée par le programme de lecture du document indépendamment
> du contenu (pour avoir une présentation uniforme),
> - ça doit être gratuit (et libre, bien évidemment)
> - et surtout, ça doit fonctionner sur enfin... euh... Windows (c'est
> drôle, ce dernier mot n'est pas reconnu par mon correcteur
> orthographique ;-)). Sur ce dernier point, ce n'est pas moi qui
> décide, mais si ça tourner *aussi* sur Linux, je trouverais ça
> vraiment génial.
> 
> Je sais que j'en demande beaucoup, mais bon, je suis un grand optimiste :-).
> 
> A bientôt.
> 
> --------------------------------
> Sebastien Adam
>   Avenue Adolphe Lacomblé 40/13
>   1030 Bruxelles
>   Belgique
> Tel/Fax : +32 (0)2 280.07.76
> GSM : +32 (0)484 930.939
> sebastien.adam.be at gmail.com
> http://www.sebastienadam.be/
> 

Salut,

Attention à ne pas confondre open-source, libre et gratuit... Ce sont 
des concepts assez différents... ;)

J'ai un peu chipoté avec LaTeX, par curiosité personnelle d'abord, et 
puis pour donner un peu plus de "gueule" à la présentation de mon CV 
(exemple de ce que ça donne après quelques heures de chipotage : 
http://www.graphix-webdesign.com/cv.pdf, ça le fait plus que tout ce que 
j'avais réussi à faire jusqu'à présent avec OpenOffice).

Le principe est simple : produire un document digne de ce qui sort d'un 
véritable imprimeur, mais en restant tout-à-fait accessible à quelqu'un 
qui n'a quasi aucune notion typographique (si tu sais ce qu'est une 
césure, c'est bon tu peux te lancer). Le but principal est en fait de 
laisser au logiciel la partie mise-en-forme, ce qui te permet de te 
concentrer d'avantage sur la structure de ton document.

Maintenant, LaTeX est parfait pour des livres, dépliants, transparents, 
documents scientifiques, mémoires, ... Mais je suppose que ta boîte 
voudra appliquer un template tout-à-fait spécifique aux documents 
produits...

LaTeX n'est qu'un langage permettant d'exploiter TeX qui est un logiciel 
de composition de documents. Peut-être qu'en cherchant de ce côté tu 
trouveras ce que tu cherches ?

En tout cas, c'est du libre, et multiplateforme...

Sinon, j'ai aussi eu l'occasion de chipoter dans la doc du projet Debian 
(pour des corrections orthographiques notamment) et eux utilisent un 
système basé sur du balisage SGML... C'est peut-être plus customisable 
mais peut-être plus touchy à mettre en place, je n'ai fait qu'utiliser 
le fichier Makefile fourni avec les sources du manuel...

L'avantage de ces 2 techniques, c'est que tu peux aussi directement 
sortir ton document en fichier PostScript, HTML, PDF, texte brut, ... A 
ta guise...

Laurent Léonard