El primer paso del proceso de documentación es conocer la información acerca del trabajo en sí que se debe realizar incluso antes de empezar con los requerimientos del desarrollo.
A continuación se presentan la información sugerida para iniciar el proceso de documentación:
El solicitante es la persona que requiere las funcionalidades implementadas. Conocer el perfil del solicitante permite entender el contexto de las necesidades que dan origen al desarrollo.
Debes definir el nivel del desarrollo según los niveles de documentación de software.
Esta clasificación indica de manera abstracta el propósito de la documentación e influye en la cantidad de información que debes solicitar y la documentación que debes entregar.
Al entender el nivel de la documentación, puedes evitar perder tiempo en recopilar información innecesaria o escribir documentos que no aportan valor al proyecto.
La prioridad indica la importancia del trabajo a realizar e influye en el orden en que se realizan las tareas.
Cada desarrollo tiene un código único que lo identifica. Este código se utiliza para referenciar el proyecto en el repositorio del código fuente y en el repositorio de documentación.
La primera página le indica al lector el contenido y propósito del documento. Esta página debe incluir todos los metadatos del documento.
El prefacio es un prólogo o introducción que resume en un sólo párrafo todo el contenido del documento.
Los anexos son archivos adicionales que complementan la información del documento principal. Los anexos pueden ser imágenes, videos, diagramas, audios, textos, etc.