| Libro blanco de las tecnologías de documentación de LuCAS: Descripción, funcionamiento, herramientas y futuro del proyecto de documentación LuCAS | ||
|---|---|---|
| Anterior | Arquitectura de desarrollo de proyectos de documentación libre (Diseño e implementación de LuCAS v4) | Siguiente |
NOTA: Como David Escorial tiene las ideas muy claras sobre este tema le delegamos toda la responsabilidad en convertir la sección en algo decente, interesante y útil para una sociedad capaz de engendrar a tipos como él.
Redacción de un manual completamente nuevo o recomendación de uno ya existente más ampliaciones específicas.
El libro de estilo es una herramienta absolutamente indispensable para todos aquellos que sin ser profesionales de la documentación necesitan crear textos destinados al público. Así pues el libro de estilo es la guía y oráculo que debe ayudar a resolver todas las dudas e inquietudes del autor.
Así debería contemplar al menos las siguientes secciones:
donde se proponga una norma de estilo literario dentro del documento o de la colección de los mismos.
donde se proponga una terminología uniforme a fin de no despistar al lector.
algo que parece imprescindible en el caso de la documentación informática en el que tanta importancia tiene el vocabulario de la jerga en inglés. Es obvio que debe estar perfectamente sincronizado con el vocabulario o que ambos formen una unidad.
con consejos y recomendaciones del uso de cada tecnología de marcas recomendada, concretamente de DocBook.
que reflejen la norma y convenios del idioma usado e instruyan su aplicación en la tecnología de documentos elegida.
bibliografía electrónica e impresa de interés.
que sugiera la manera de realizar las revisiones y ofrezca indicaciones de cómo llevarlas a cabo.