Está en la página 1de 3

[Nombre del proyecto]

Estándar de Documentación de Usuario


Versión [1.0]
[Este documento es la plantilla base para elaborar el documento Estándar de
Documentación de Usuario. Los textos que aparecen entre paréntesis rectos son
explicaciones de que debe contener cada sección. Dichos textos se deben
seleccionar y sustituir por el contenido que corresponda. Para actualizar la tabla de
Contenido, haga clic con el botón derecho del ratón sobre cualquier línea del
contenido de la misma y seleccione Actualizar campos, en el cuadro que aparece
seleccione Actualizar toda la tabla y haga clic en el botón Aceptar.]

Historia de revisiones
Fecha Versión Descripción Autor
[dd/mm/aaaa] [x.x] [detalles] [nombre]

Estándar de Documentación de Usuario Página 1 de 3


Contenido
1.FORMATO................................................................................................................................................3

2.IMÁGENES...............................................................................................................................................3

3.SECCIONES.............................................................................................................................................3

4.PRÁCTICAS.............................................................................................................................................3

Estándar de Documentación de Usuario Página 2 de 3


1. Formato
[Se especifican las normas de formato que se deberán seguir para realizar la
documentación de usuario, incluyendo tipo de letra y tamaño para el texto
normal, tipo de letra, tamaño y numeración para los distintos títulos, tamaño
y márgenes de las hojas, formato del índice y apéndices, etc.]

2. Imágenes
[Se especifican las normas que se deberán seguir para la inclusión de
imágenes en la documentación, incluyendo herramienta para capturar las
imágenes, tipo de las imágenes como ser gif o jpg, tamaño de las imágenes a
incluir, etc.]

3. Secciones
[Se especifican las secciones que serán incluidas en la documentación de
usuario, por ejemplo introducción, definiciones, ejemplos, etc. y definición del
contenido que se incluirá en cada una, teniendo en cuenta que es importante
proveer documentación para todos los tipos de usuario, y que los Casos de
Uso son la guía básica para el desarrollo de la misma.]

4. Prácticas
[Se especifican las prácticas a seguir para realizar la documentación de
usuario, como por ejemplo forma de organizar la información para su fácil
acceso, tipo de redacción, especificación de las instrucciones para que puedan
ser seguidas fácilmente, diferenciación entre conceptos, terminología,
acciones, objetivos, etc.]

Estándar de Documentación de Usuario Página 3 de 3

También podría gustarte