¿Qué es la documentación?

La documentación incluye muchas cosas.

Primero, la documentación incluye la redacción de una especificación de características / sistemas que planea implementar. Esta podría ser una propuesta. Podría describir flujos de trabajo en inglés simple. Puede incluir escenarios de usuario. Puede incluir diagramas o diagramas de flujo. Algunas personas usan UML para diagramar. Puede incluir una lista de requisitos (tanto funcionales como no funcionales). Aquí hay dos ejemplos:

http://www.kurlak.com/john/Proje …
http://www.kurlak.com/john/Proje …

A continuación, la documentación también puede ser parte de su código. Algunas personas consideran que las pruebas unitarias son parte de la documentación. Otros consideran que los comentarios en los métodos, los métodos anteriores, las clases anteriores y en la parte superior de los archivos son documentación. Algunos consideran que las buenas convenciones de nomenclatura y la estructura del código son documentación.

La documentación también puede ser cualquier cosa que los programadores escriban para otros programadores. Esto puede incluir un sistema de seguimiento de errores, un sistema de seguimiento de tareas, una lista de software de código abierto o complementos que se están utilizando, instrucciones para trabajar con el código, un documento estándar, etc.

Además, la documentación puede ser las instrucciones que escribe para usar cualquier API que pueda exponer. Por ejemplo, mire la especificación Api de Java Platform SE.

Y finalmente, la documentación puede ser instrucciones / páginas de ayuda para los usuarios de su software. Por ejemplo, consulte la Ayuda de Google.

Wikipedia: Un documento es una representación escrita, dibujada, presentada o memorizada del pensamiento. La palabra se origina del latín documentum, que denota una “enseñanza” o “lección”: el verbo doceō denota “enseñar”.

En el pasado, la palabra se usaba generalmente para denotar una prueba escrita, útil como evidencia de una verdad o hecho.

La documentación es algo que siempre está incompleto, desactualizado, mal escrito o incoherente / contradictorio y es importante para otros ingenieros de software.

El código fuente es el mismo en una forma diferente, pero además de otros ingenieros de software también es importante para las computadoras, por lo que se le presta un poco más de atención a los errores ortográficos que a la documentación.

La documentación es como un seguro a término: satisface porque casi nadie que se suscribe depende de sus beneficios.

La documentación es donde un usuario / codificador podrá leer sobre cómo funciona un código y cómo usarlo, así como dónde funciona, dónde funciona parcialmente y dónde no.
Es como una guía de usuario.