Skip to content

Latest commit

 

History

History
46 lines (25 loc) · 1.64 KB

meta.md

File metadata and controls

46 lines (25 loc) · 1.64 KB

volver al inicio

Ir a preámbulo

Metadatos de un documento de software

Título

Es un conjunto de pocas palabras que resumen el contenido y propósito del documento.

El título permite inferir el contenido del documento y facilita la búsqueda y recuperación del archivo en un repositorio de documentos.


Descripción del documento

Es un texto que describe el contenido y tipo del documento. La descripción del documento debe estar en el encabezado del documento, asi el lector sabrá si es de su interés.

El siguiente es el esquema general de la frase inicial de un documento:

<tipo de documento> acerca de <contenido> para <perfil del lector> con el fin de <propósito>

Ejemplo práctico:

Manual de usuario acerca del funcionamiento del software de control de inventarios para el personal de almacén con el fin de capacitar al personal en el uso del sistema

Autor

El autor es la persona que escribe el documento. Al especificar el autor debes incluir un medio de contacto y datos que identifiquen a la persona.

Ejemplo:

Autor: Jhon Doe ( [email protected] )


Fecha y versión

La fecha es muy importante ya que el software evoluciona constantemente y la documentación puede quedar desactualizada. La documentación antigua puede ser confusa o errónea para un usuario con una versión más reciente del software.

El formato de la fecha queda a disposición del autor, pero se recomienda que al menos contenga el año y mes de publicación.

Como buena práctica, se recomienda agregar la versión del software al que hace referencia el documento.