Documentación | Arquitectura y módulos

Empieza por lo que necesitas saber

Si estás evaluando ApisKit

Puedes comprobar qué decisiones forman parte de la plantilla y qué responsabilidades seguirán dependiendo de tu producto, tu infraestructura y tu negocio.

Si ya tienes una copia

La documentación pasa a ser la referencia del proyecto. Está pensada para acompañar el código: explica las decisiones que necesitas conocer para trabajar sobre la base sin tener que reconstruir primero cómo está organizada.

Si quieres reutilizar una pieza

ApisKit no está planteado como un bloque indivisible. Algunas partes están diseñadas para poder trasladarse a otros proyectos manteniendo explícitas sus dependencias y los contratos que necesitan del sistema que las recibe.

Una documentación que forma parte del producto

Las páginas publicadas forman parte de la puerta de calidad de ApisKit.

El sistema comprueba automáticamente condiciones que el análisis del código por sí solo no puede detectar, como documentación incompleta, idiomas ausentes, direcciones duplicadas, páginas fuera de la navegación o imágenes sin la información necesaria.

Si una comprobación no puede ejecutarse, no se presenta como correcta.

No solo documenta qué hacer

Cuando una decisión afecta al comportamiento del sistema, la documentación explica también por qué existe, de qué depende y qué puede dejar de funcionar si se cambia.

Al revisar una decisión	Puedes identificar
Por qué existe	El problema o la responsabilidad que está resolviendo.
De qué depende	Las partes del sistema, servicios o contratos que intervienen.
Qué protege	El comportamiento que esa decisión intenta mantener.
Qué cambia si la sustituyes	Lo que tendrás que conservar, adaptar o volver a implementar.

La intención no es que conserves cada decisión de ApisKit para siempre. Es que, cuando la sustituyas, sepas qué problema estaba resolviendo y qué responsabilidad pasa a ser tuya.