Documentación
Lee el razonamiento, no solo el resultado
Casi todo lo que merece la pena saber de este producto está escrito, incluidas las decisiones que resultaron equivocadas y se revirtieron.
Esto no es un producto con una web de marketing y una caja negra cerrada detrás. El razonamiento está documentado porque el razonamiento es el producto: una herramienta de gobierno del dato que no sabe explicarse está pidiendo justo la confianza que venía a sustituir.
Empieza por aquí, según lo que quieras hacer
- Entender cómo se alcanza una conclusión
- La página de metodología describe las cuatro clases de evidencia, cómo se versionan las reglas y por qué UNKNOWN es un resultado y no un fallo.
- Sacar adelante una revisión de seguridad
- La página de seguridad declara qué se lee, qué no se lee nunca y sobre qué se sostiene realmente la promesa de solo lectura.
- Ver si encaja con tu stack
- La página de cómo funciona lista los motores, los frameworks de aplicación y ORM, y los formatos de descripción de API que se leen.
- Meterlo en un pipeline
- La página de desarrollo cubre la línea de comandos, los códigos de salida y las puertas de gobierno.
- Entregarle algo a un auditor
- Hoy, exporta los informes. La página de paquete de evidencias describe el archivo previsto, su manifiesto y cómo se verificará su integridad.
Registros de decisiones de arquitectura
Cada decisión relevante de este código tiene un registro numerado: el contexto, la decisión, las consecuencias aceptadas y las alternativas que se descartaron y por qué. Los registros que hacen una afirmación de seguridad o de corrección la declaran como una garantía con nombre, y algún test tiene que referenciar ese nombre o la build falla, de modo que una promesa documentada no puede alejarse en silencio del código que debería sostenerla.
Se distribuyen con el código. Si estás evaluando el producto en serio, es lo más útil que puedes leer.
Dentro de la aplicación
La pantalla Acerca de contiene el histórico de versiones, la versión del conjunto de reglas y para qué está configurado este despliegue. Ajustes muestra la mitad del operador: si hay un proveedor de identidad, si algo sale de la plataforma y qué se le permite hacer a un asistente.