Documentación de Software

Proceso de escritura¶

1. Planificación - Propósito - Audiencia - Entrega
2. Investigación - Preguntando a expertos - Revisando documentación - Utilizando el Software
3. Escritura
4. Organizar contenido e ideas
5. Escribir el primer borrador
6. Repasar y corregir
7. Revisión/Edición - Reorganizar contenido - Modificar estilo - Corregir gramática y puntuación - Incorporar resultados de las pruebas
8. 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
• 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
• Script
• Ejemplos
  • Comic Sans MS
  • Freestyle Script
  • Lucida Calligraphy
  • Segoe Script
• Características
  • Simula escritura a mano
  • Caligráfica
  • Fantasía
• Uso
  • En muy limitadas ocasiones
  • No recomendado para documentación seria
  • Puede impedir legibilidad
• 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

Documentación C4 (Simon Brown)¶

Consiste en documentar el software en los siguientes niveles: