Soy un desarrollador aficionado y todos mis programas hasta ahora eran lo suficientemente simples como para documentarse en el código. Mientras leía el código, estaba claro lo que estaba haciendo tal y tal acción (mi prueba estándar fue mirar el código 6 meses después y entender todo a la primera lectura, y tengo un corto espacio de memoria).
Ahora me enfrento a un programa que está superando mis capacidades para recordar las diversas interacciones entre
- el código en sí
- los índices en la base de datos
- las interacciones entre varios módulos (código central "trabajador" y "biblioteca")
Mi documentación actual es una pizarra donde tengo todo tipo de cuadros y flechas que apuntan al código, a los índices de la base de datos, a las acciones que se ejecutan, al cambio de estado, etc. Solo como referencia, un fragmento del desastre:
Mi pregunta es si existe un conjunto estándar o nombrado de mejores prácticas (nombrado en el sentido de que este es un conjunto de prácticas que se agruparon bajo un nombre específico) para la documentación de productos más complejos.
¿Cuáles son las palabras clave que debo buscar? (Los intentos generales de "documentar estándares de arquitectura de software" y variaciones similares generalmente condujeron a software para flujos de trabajo o sistemas CAD de arquitectura de edificios).
También espero que no haya mejores prácticas generales para descripciones de alto nivel y que cada uno construya su propia filosofía.