Di seguito vengono mostrati alcuni suggerimenti per accrescere affidabilità, leggibilità e 'formattabilità' della vostra documentazione.
Provate voi stessi gli esempi da inserire nella pagina man, così da verificarne il reale funzionamento (usate il copia-e-incolla dalla pagina man per assicurarvi di immettere l'esatta sequenza sulla riga di comando usata per i test). Non riportate l'output del comando come voi pensate che venga prodotto, ma copiate l'output reale.
Rileggete, usate ispell e fate leggere la documentazione a qualcun altro, specialmente se l'inglese non è la vostra lingua madre. L'HOWTO che state leggendo, ad esempio, ha appena passato il suo ultimo test (un ringraziamento speciale va a Michael Miller per il suo contributo particolarmente eroico! Tutte le imperfezioni rimanenti sono interamente attribuibili a me). Altri contributi sono sempre bene accetti.
Verificate la vostra pagina man: quando la passate alla formattazione con groff vengono visualizzati errori? Il comando man(1) si lamenta quando eseguite man mioprogramma? Fornisce il risultato atteso? xman(1x) e tkman(1tk) fanno cilecca con il vostro manuale? Con XFree86 3.1 c'è xman 3.1.6 - X11R6, che prova ad effettuare una decompressione usando gzip -c -d < %s > %s zcat < %s > %s
Il comando makewhatis(8) è in grado di estrarre la descrizione dalla sezione NOME?
Traducete la vostra pagina man in formato HTML usando rman prelevabile da http://polyglotman.sourceforge.net/ e visualizzate il risultato con molti browser Web (netscape, mozilla, opera, lynx, ...). Verificate che i riferimenti incrociati tra le vostre pagine man funzionino, nel codice HTML generato, come link ipertestuali. Se il vostro programma ha un sito dedicato, pubblicateci le sue pagine man e tenetele aggiornate.
La utility rman può tradurre le pagina man anche in LaTeX, RTF, SGML e altri formati; verificate anche questi, se volete accludere le pagine man in un libro o in un documento più ampio.
Provate a tradurre le pagine man in HTML usando man2html, che è parte del pacchetto man di Linux fin dalla sua versione man-1.4. La utility man2html è un traduttore meno ambizioso di rman, ma quasi tutti gli utenti Linux lo possiedono, cosicché è importante assicurarsi che man2html non manchi di elaborare correttamente la vostra pagina man.