Código sin documentación es código perdido
La documentación no es un lujo, es una necesidad. Un proyecto sin documentación es imposible de mantener, escalar o transferir. Creamos documentación clara, útil y mantenible.
Tipos de documentación
- API docs: OpenAPI/Swagger, ejemplos de uso, autenticación
- Arquitectura: Diagramas C4, decisiones de arquitectura (ADR)
- Onboarding: Guías para nuevos desarrolladores
- Deployment: Paso a paso para poner en producción
- Usuario final: Manuales de uso del sistema
- README: Documentación de proyecto en repositorio
- Runbooks: Procedimientos para operaciones comunes
Formatos
- Markdown en repositorio
- Swagger/OpenAPI para APIs
- Confluence/Notion
- PDFs exportables
- Videos tutoriales