Contenido de la documentación06 / 16

El flujo de trabajo principal06 / 16

Leer explicaciones y evidencia

En esta página

Las explicaciones de la implementación te permiten partir de una parte de la intención, entender cómo funciona el código y encontrar evidencia que respalde esa descripción. Céntrate en el comportamiento, el material de apoyo y las preguntas que aún requieren tu criterio.

Abre explicaciones de párrafo y locales

Pulsa el texto del documento para editarlo. Pulsa el espacio vacío dentro de un párrafo, fuera de su texto, para abrir la explicación del párrafo, marcada como L1.

Algunas explicaciones se refieren a una palabra o frase. Pasa el cursor sobre el párrafo para mostrar subrayados cortos y pulsa uno para leer su explicación local, marcada como L2.

Las listas, tablas y bloques de código también pueden tener explicaciones. Una lista completa se investiga conjuntamente; los encabezados no se investigan por separado.

Puedes mantener abiertas notas al margen de varios párrafos. Cada párrafo muestra una explicación de párrafo o local a la vez. En una ventana estrecha, la nota puede aparecer debajo del párrafo.

Lee las tres secciones

SecciónPregunta que respondeEn qué fijarte
Implementación¿Cómo aborda la implementación esta intención?Comportamiento, pasos, casos límite y decisiones de implementación.
Evidencia¿Qué respalda la explicación?Referencias al código, pruebas, salida de comandos y otro material que puedas examinar.
Atención¿Qué requiere más valoración?Carencias, decisiones de implementación, riesgos y sugerencias.

Implementación aparece expandida por defecto. Expande Evidencia cuando lo necesites. Atención se oculta cuando no hay puntos que mostrar.

Para una recompensa tras 7 registros consecutivos, la explicación podría describir cómo se acumulan las fechas, citar la función y las pruebas pertinentes, y señalar cómo se gestionan los viajes entre zonas horarias. El contenido real depende de la investigación de tu proyecto.

Examina la evidencia

Las referencias al código abren los archivos en la aplicación predeterminada del sistema. Las imágenes se pueden ver y ampliar en la nota al margen. Las etiquetas de material como salida de comandos y diferencias de código abren una pestaña nueva. Noea te avisa si el material ya no está disponible.

Pregúntate si cada referencia responde a tu pregunta, qué condiciones cubre una prueba y si los resultados respaldan la conclusión. Si falta un escenario importante, pregunta sobre el párrafo y solicita más investigación o verificación.

En particular, distingue tres tipos de evidencia:

MaterialQué ayuda a establecerQué no establece
Código de implementación o de pruebasLa lógica utilizada y los escenarios definidos por las pruebas.Que existan pruebas no significa que se hayan ejecutado o superado.
Resultados de ejecuciones anterioresQué se ejecutó entonces y cuál fue el resultado en ese momento.Los cambios posteriores de código pueden hacer que esos resultados ya no sean aplicables.
Verificación realmente ejecutada ahoraEl resultado para el entorno y el alcance de esta ejecución.Superar los escenarios cubiertos no demuestra que los no probados funcionen correctamente.

Explicar e Investigación normalmente leen el código y la evidencia existente, en lugar de volver a ejecutar siempre las pruebas, la compilación o la aplicación. Verifican un hecho cuando es necesario y la lectura por sí sola no permite establecer algo esencial para la valoración. Evalúa el alcance de la verificación a partir de lo que se ejecutó realmente.

Para volver a ejecutar una prueba concreta, pide al Agente en el chat que la ejecute e informe de su alcance y resultado; después investiga de nuevo el párrafo correspondiente.

Decide qué decisiones pertenecen a la intención

Una explicación que dice «La implementación utiliza actualmente almacenamiento local» describe el enfoque de hoy; no exige que las versiones futuras lo usen. Los requisitos que quieras conservar pertenecen al documento de intención.

Considera si una decisión afecta a la experiencia de uso, el coste, la privacidad, el riesgo o las decisiones futuras. Cuando la entiendas, hay dos resultados habituales:

  • El enfoque actual es aceptable y quieres dejar margen para cambiarlo más adelante: sigue utilizándolo sin convertirlo en una restricción.
  • El enfoque debe mantenerse en futuras versiones: escribe el requisito explícitamente y revisa las limitaciones que introduce.

Por ejemplo, hoy puedes aceptar el almacenamiento local de los registros diarios. Si el uso sin conexión se vuelve esencial, escribe «Los usuarios pueden seguir registrando su actividad sin conexión a la red» e investiga cómo lo permite la implementación. Expresar el comportamiento que necesitas suele ser más fácil de mantener que copiar una descripción detallada de la implementación.

Entiende la sección Atención

Los elementos de Atención se clasifican en carencias, decisiones de implementación, riesgos o sugerencias. Distinguen el comportamiento ausente de las decisiones de diseño actuales y de los temas que merece la pena seguir debatiendo.

El indicador de atención a la derecha de un párrafo abre la explicación correspondiente. Su número cuenta paneles de explicación que contienen puntos de atención, no problemas individuales. Una carencia hace que el indicador tenga un color más destacado.

Entiende el impacto antes de decidir si corriges el código, añades verificación, cambias la intención o conservas el comportamiento actual. No todos los puntos de atención deben convertirse en requisitos. La ausencia de indicador solo significa que la explicación actual no enumera ninguno.

Explora ilustraciones del comportamiento

Algunas explicaciones incluyen una pequeña ilustración interactiva del comportamiento. Puedes probarla, reiniciarla o examinar su código fuente.

Estas ilustraciones se ejecutan en un entorno aislado sin acceso a la aplicación ni a la red, y no guardan el estado de interacción. Explican una regla; comprobar si el software real la cumple sigue requiriendo código y evidencia de verificación.

Comprueba si una explicación sigue siendo aplicable

Texto anterior significa que la explicación cubre la intención previa a tu edición. Puede estar desactualizado indica que los archivos leídos o citados por la explicación cambiaron después de la investigación. Ambos son motivos para volver a investigar.

Las notas al margen son de solo lectura. Edita la intención para cambiar un requisito; utiliza Investigación o Investigar de nuevo para comprobar una explicación. Consulta Mantener las explicaciones al día.