Introducción sobre cómo contribuir |
La documentación de alta calidad es tanto un asunto de contenido como de estructura. El contenido en sí mismo tiene que ser tan pedagógico como sea posible para el grupo de lectores objetivo. A fin de lograr esto, usted no debe vacilar en proveer tantos ejemplos y capturas de pantalla ilustrativas cuando sea adecuado. Aunque la documentación no pretende ser necesariamente completa, intemas proveer documentación relativamente estable. En particular, usted debe haber revisado su texto confrontando errores de pronunciación. La documentación más experimental debería ponerse en el directorio incoming o en el TeXmacs Wiki.
Es también importante que usted de a su documentación tanta estructura como sea posible, usando etiquetas especiales del archivo de estilo tmdoc. Esta estructura puede ser usada a fin de compilar automáticamente libros imprimibles desde su documentación, para hacerla apropiada para diferentes formas de visión, o para hacerla posible para buscar eficientemente cierto tipo de información en la documentación. En particular, debe siempre proveer información sobre copyright y licencia, como también indicaciones sobre cómo recorrer su información, si contiene muchos archivos.