Pourquoi �crivons-nous une documentation ? C'est une question b�te. Parce que nous voulons que d'autres personnes puissent utiliser notre programme, notre fonction dans une librairie ou quoi que ce soit que nous avons �crit et rendu disponible. Mais �crire une documentation n'est pas suffisant :
man(1). Ce HOWTO d�crit
ce que vous devez faire pour �crire une page de manuel qui
sera correctement trait�e par les outils pr�vus � cet effet,
dont les plus importants sont man(1), xman(1x),
apropos(1), makewhatis(8) et
catman(8).La qualit� et la v�racit� des informations sont, bien s�r, de votre ressort. Malgr� tout, vous trouverez dans ce guide quelques id�es qui vous permettront d'�viter certains pi�ges courants.
Hosting by: Hurra Communications GmbH
Generated: 2007-01-26 18:01:31