En mi proyecto fin de carrera de la Ingeniería Técnica Informática hice un amplio estudio sobre lo que por aquellas era una tecnología emergente y que prometía, la virtualización. Y más concretamente sobre Xen.
Por aquel entonces, por los apuros con la documentación y estar cursando en paralelo la superior, opté por realizarla en OpenOffice y, aunque desde mi punto de vista para documentos pequeños va genial, para documentos grandes quizás se queda algo corto. Con corto me refiero a que manejar un documento de 150 páginas, con texto e imágenes todo se movía muy lento y tuve muchos problemas para conseguir un resultado final bueno.
Para el PFC de la Superior decidí no cometer el mismo error, así que opté por emplear LaTeX como lenguaje de documentación. Durante toda la documentación sobre Puppet, estuve aprendiendo también en paralelo una gran cantidad de cosas de LaTeX y la verdad, la calidad de la documentación fue inigualable. Gracias a ello, conseguí una mención especial del tribunal sobre dicha documentación.
Puesto que iba a emplear LaTeX, una de las cosas que más me interesaba era tener el mismo aspecto en todos los lugares de la documentación. Por suerte, LaTeX soporta estilos, por lo que eso facilitó enormemente la labor de crear documentación. No tanto el trabajo de hacerlos. Los estilos más destacados los comento a continuación,
- LaTeX, source code
- LaTeX, comandos del sistema
- LaTeX, configuración destacada
- LaTeX, notas
- LaTeX, notas de advertencia
En posteriores entradas iré mostrando el código necesario para crearlos y que si os hace falta podréis modificar a vuestro gusto. El capítulo iniciar de la documentación, el que hace referencia a las notaciones empleadas, tiene la siguiente pinta.
No hay comentarios :
Publicar un comentario