Estructura De Los Manuales

Estructura de los manuales
nombre | Partes del libroEstructura externa | Nombre | Partes de un manualtécnico |
cubierta | En la cubierta lleva el título de la obra, su autor, e ilustraciones o diseños para hacerlo identificable y atractivo. | Identificación del documento | Logotipo de la organización. |
lomo | Es la parte donde se sujetan todas las hojas. Suele llevar título, autor yeditorial. | | Nombre oficial de la organización. |
solapa | Es donde se imprime una lista de los libros de la colección, comentarios u otros datos parecidos. Se usa como separador. | | Denominación y extensión. De corresponder a una unidad en particular debe anotarse el nombre de la misma. |
chaqueta | (También llamada «forro»). | | Lugar y fecha de elaboración. |
Parlamento editorial | Leindican al comprador la editorial, en dónde, en qué lugar y en qué fecha se imprimió el libro, y de cuántos ejemplares fue el tiraje. | | Número de revisión (en su caso). |
| Partes del libroEstructura interna | | Unidades responsables de su elaboración, revisión y/o autorización. |
Portadilla o anteportada | Es la hoja que antecede a la portada y la primera página impar impresa, en la quesólo se presenta el título de la obra y el autor resumidos y, a veces, la colección o un resumen antes del inicio del libro. | | Clave de la forma. En primer término, las siglas de la organización, en segundo lugar las siglas de la unidad administrativa donde se utiliza la forma y, por último, el número de la forma. Entre las siglas y el número debe colocarse un guión o diagonal. (en su caso) |contraportada | Es la página que sigue a la portada, y se puede decir que es la única página fija de un libro. Lleva los créditos de autoría y de traducción, los elementos legales tales como el titular número internacional normalizado del libro y el depósito legal. Debe llevar la razón social, la dirección de la empresa editora y el año de publicación del libro. | | Una vez concluido el desarrollode un sistema, considerando para esto los posibles cambios que se efectúen durante la etapa de garantía de que lo cubre (si así fuera el caso), el usuario final del sistema debe recibir una versión actualizada final del documento manual técnico. |
Paginas preliminares | los siguientes elementos no tienen un sitio fijo, siendo el orden más lógico el siguiente: | Estructura del manual técnico |1-ÍndiceRelación de los capítulos y páginas correspondientes que forman parte del documento |
presentación | Hecha por el editor o la persona de mayor responsabilidad, no necesariamente vinculada al texto, pero sí a la edición. | Estructura del manual técnico | 2-Introducción.Se debe presentar una breve descripción del sistema desarrollado, que contemple el ámbito abarcado, cual es su funciónprincipal y un detalle de las funciones macros o partes que lo componen. Puede incluir un mensaje de la máxima autoridad de las áreas comprendidas en el manual. |
Prefacio o introducción | Hecho por una persona que entienda del tema del libro de un modo general, un editor, un profesor o un especialista. | | 2.1. Objetivo general del sistemaSe debe de describir el objetivo general del sistema. |Índice general | Que da paso ya al contenido propiamente dicho. | | 2.2. Objetivos específicosSe deben describir brevemente los objetivos específicos que se cumplieron con el desarrollo del sistema. |
prologo | Responsabilidad del autor y que da cuenta del contenido. | | 3. Contenido técnico |
Cuerpo de la obra | Es el texto principal de un libro o folleto. | | 3.1. Definición de reglas delnegocio implementadas en el sistema desarrollado. |
agradecimientos | Que se colocan con bastante libertad, normalmente después de la contraportada, a menudo en una página posterior, tras la portadilla, o antes del prólogo, enfrentado con él en una página vuelta. | | 3.2. Diagramas de flujo de datos, junto con su respectivo diccionario de datos. |
dedicatoria | Que escribe a mano un autor,...