Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la GDOC Season of Docs.
Resumen del proyecto
- Organización de código abierto:
- El proyecto FreeBSD
- Redactor técnico:
- El rey de las tostadoras
- Nombre del proyecto:
- Escribe las páginas man faltantes y agrega secciones de EJEMPLO a las páginas man
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Escribe las páginas man faltantes:
Hay una lista de las páginas de man que faltan en https://wiki.freebsd.org/MissingManpages. Comienza a escribir tantas páginas de esa lista como sea posible. Con la ayuda de tu mentor, busca al autor o a alguien que haya cambiado recientemente el archivo fuente del que se trata la página del manual en cuestión para obtener información general y detalles.
Agrega secciones de EJEMPLO a las páginas del manual:
En muchos lugares, las páginas del manual de FreeBSD incluyen secciones EJEMPLO que describen el uso básico de la utilidad o el comando que se describen en ellas. La wiki de FreeBSD tiene una lista de páginas de man sin ejemplos (https://wiki.freebsd.org/ManPagesWithoutExamples). Agrega la mayor cantidad posible de ejemplos a estas páginas man en los casos en que tenga sentido incluirlas. Crea una forma general de presentar el comando o la utilidad en estas secciones (es decir, primero el inicio rápido y, luego, ejemplos más avanzados) y aplícala a las páginas man que describen utilidades o comandos similares. De esta manera, los ejemplos tienen un enfoque coherente y el lector puede encontrar las cosas más fácilmente.