Documentación de Software
Contenido
Notas sobre la documentación de software
Proceso de escritura
- Planificación
- Propósito
- Audiencia
- Entrega
- Investigación
- Preguntando a expertos
- Revisando documentación
- Utilizando el Software
- Escritura
- Organizar contenido e ideas
- Escribir el primer borrador
- Repasar y corregir
- Revisión/Edición
- Reorganizar contenido
- Modificar estilo
- Corregir gramática y puntuación
- Incorporar resultados de las pruebas
- Lanzamiento
- Como parte final crear un plan para las actualizaciones
Reglas
- Precisión
- Claridad
- Concisión
- Tono
- Consistencia en los tiempos verbales
- Gramática, ortografía y terminología
Diseño
Tipografía
Existen cuatro categorías básicas de tipografía:
- Serif
- Ejemplos
- Adobe Garamond
- Bodoni MT
- Rockwell
- Times New Roman
- Características
- Clásica
- Tradicional
- Bonita
- Uso
- Material impreso
- Títulos
- Tamaño de fuente 12 o mayor
- Puede dar un aspecto no profesional en la web
- No le gusta a todo el mundo
- Ejemplos
- Sans serif
- Ejemplos
- Franklin Gothic
- Helvetica
- Tahoma
- Verdana
- Características
- Moderna
- Minimalista
- Limpia
- Uso
- Web
- Cualquier tamaño
- Aspecto profesional
- Gusta a todo el mundo
- Ejemplos
- Script
- Ejemplos
- Comic Sans MS
- Freestyle Script
- Lucida Calligraphy
- Segoe Script
- Caracteristicas
- Simula escritura a mano
- Caligráfica
- Fantasía
- Uso
- En muy limitadas ocasiones
- No recomendado para documentación seria
- Puede impedir legibilidad
- Ejemplos
- Decorative
- Ejemplos
- Algerian
- Broadway
- Curlz MT
- Rosewood STD Regular
- Características
- Divertida
- Única
- Expresiva
- Uso
- En muy limitadas ocasiones
- No recomendado para documentación seria
- Puede impedir legibilidad
- Ejemplos
Documentación C4 (Simon Brown)
Consiste en documentar el software en los siguientes niveles:
