¿Cómo escribo una página de manual?
¿Dónde puedo encontrar una referencia de todos los códigos de formato?
¿Hay algún buen tutorial sobre cómo escribir páginas de manual?
¿Cuál es la forma más conveniente de escribir una página de manual? ¿Debo ingresarlo directamente en un editor de texto? ¿Hay editores WYSIWYG? ¿O debería escribirlo en un formato diferente y luego convertirlo?
¿Qué reglas debe seguir una buena página de manual?
documentation
amarillion
fuente
fuente
man man
,man groff
.Respuestas:
Aquí hay algunas páginas web que lo ayudarán a comenzar:
Un par de herramientas útiles:
fuente
Existen herramientas para escribir páginas man que omiten el formato troff. Las páginas de manual son un lenguaje pequeño, bien delimitado y fácil de orientar.
Dos herramientas populares son:
yodl y zoem parecen ser otros formatos agradables en este espacio.
En general, recomendaría xmltoman porque es un dsl muy específico de la página de manual que lo guiará de cerca.
fuente
He escrito un artículo de blog bastante extenso sobre el tema, que puedes encontrar aquí:
fuente
No conozco ningún IDE o tutorial, pero puede comenzar copiando una página de manual existente y modificarla para satisfacer sus necesidades.
Para obtener una referencia del lenguaje groff con macros MAN (que es lo que usa una página man), consulte la página man groff_man , o léalo en línea aquí
fuente
Echa un vistazo al proyecto ronn . Es un descuento para el generador de páginas de manual. También puede generar las páginas man en html, de esta manera .
Me gusta la idea de escribir toda mi documentación de software en un formato. Markdown IMO es una buena opción
fuente