跳转至

译文

译自西班牙语原文,以原文为规范文本。 状态:草稿,待人工审校。如有歧义,以西班牙语原文为准。

模板

本页为要求中的每一种开放格式提供一个模板,另加一份环境声明和一份分支模型声明。每个模板都以一个虚构示例填写:Ana 的网店及其工作项 TIE-12,“将订单导出为 CSV”。

如何使用

  • 不强制任何序列化方式。这些代码块使用键值表示法(通用 YAML)只是为了便于阅读;任务管理工具、仓库中的文件或电子表格都可以包含同样的字段。
  • 这些字段是要求所规定的最少字段。项目可以增加其他字段;当要求适用时,不得省略必填字段。
  • 数据均为虚构。不要复制真实的邮箱、姓名或密钥;指纹、日期和人员的取值都是编造的。邮箱地址使用保留域名 .invalid。
  • 发布模板不产生义务,也不批准任何配置。填写好的模板只是记录一项声明;它不能证明该声明属实,也不能证明工作做得好。
  • 不知道的内容写作 desconocido 或 hipótesis,而不是当作数据。

完整的周期请参阅项目周期、工作与节奏、分支、环境与发布版本和小组。

项目章程

R-019 的格式。由产品负责人在第一个功能类批次之前填写。

carta_de_proyecto:
  version: 1.0
  fecha: 2026-10-01
  objetivo: Vender artesanías en línea con envío nacional.
  problema: Hoy los pedidos se llevan en una hoja de cálculo y se pierden pedidos.
  alcance: Catálogo, carrito, pago, pedidos y exportación de pedidos.
  exclusiones: Envíos internacionales; aplicación móvil.
  responsables:
    producto: Ana
    coordinación: Ana
    técnica: Ana
    entrega: Ana
  catalogo_de_efectos_criticos:
    - desplegar en producción
    - pagos o transferencias
    - borrado de datos (por ejemplo, borrar pedidos)
    - cambios de permisos
    - publicación o envío a terceros (por ejemplo, correos a clientes reales)
    - decisiones que afecten a personas
  restricciones_de_datos:
    - Los datos de clientes reales sólo existen en producción.
    - Los demás entornos usan datos sintéticos.
  criterio_de_exito: Todo pedido recibido aparece en la lista de pedidos en menos de un minuto.
  historial_de_cambios:
    - {version: 1.0, fecha: 2026-10-01, decidió: Ana, motivo: versión inicial}

现状盘点

R-020 的格式,用于在已有工作之上采用 SCAFFOLD。每一项数据要么是带来源的事实,要么是假设。

levantamiento:
  fecha: 2026-10-02
  repositorios:
    - {nombre: tienda, dato: hecho, fuente: lista de repositorios del servicio}
  entornos:
    - {nombre: producción, dato: hecho, fuente: panel del proveedor de alojamiento}
    - {nombre: pruebas, dato: hipótesis, nota: Ana cree que existe; no se ha verificado}
  comprobaciones:
    - {nombre: pruebas automáticas, ultimo_resultado: fallan 3 de 40, dato: hecho, fuente: ejecución del 2026-10-02}
  versiones_en_uso:
    - {componente: tienda, version: desconocida}
  duenos: [{area: pagos, dueno: Ana, dato: hecho, fuente: Ana}]
  deuda_y_riesgos:
    - {descripcion: sin copia de seguridad probada, dato: hipótesis}
  trabajo_en_curso:
    - {descripcion: exportar pedidos, destino: elemento TIE-12}
    - {descripcion: rediseño de portada, destino: descartado, motivo: fuera de alcance de la carta}

工作项

R-021 的格式,状态取自 R-023。状态为 propuesto、listo、en_curso、en_revisión、terminado 或 descartado;这是一套独立的方案,不同于批次或说明的状态方案。

elemento_de_trabajo:
  identificador: TIE-12
  tipo: función            # iniciativa, función, corrección, reestructuración, investigación u otro declarado
  objetivo: Exportar pedidos a CSV.
  criterios_de_aceptacion:
    - El archivo incluye número de pedido, fecha, total y estado.
    - Con 1000 pedidos de prueba el archivo se genera sin error.
  responsable: Ana
  estado: en_curso
  padre: TIE-3             # o ninguno
  dependencias: []
  lotes: [L-2026-014]
  ramas: [función/TIE-12-exportar-csv]
  cambios: [referencias en los mensajes con el trailer Refs: TIE-12]
  version: pendiente

合并请求

R-025 与 R-026 的格式。

solicitud_de_integracion:
  elemento_o_lote: TIE-12 / L-2026-014
  rama: función/TIE-12-exportar-csv
  responsable: Ana
  asistentes_que_intervinieron: [asistente-de-codigo, asistente-de-pruebas]
  comprobaciones:
    - {nombre: pruebas automáticas, resultado: pasan}
    - {nombre: versión de contrato y código coinciden, resultado: pasan}
    - {nombre: exclusión de la capa de ingeniería, resultado: pasa}
  revisor_humano: Beto
  efectos_criticos_que_toca: ninguno

部署记录

R-027 与 R-028 的格式。

registro_de_despliegue:
  version: 1.4.0
  huella_del_artefacto: sha256:ejemplo-ficticio-0f3a   # la huella real la calcula la herramienta de construcción
  entorno: producción
  persona_que_autorizo: Ana
  comprobaciones: [pruebas automáticas, exclusión de la capa de ingeniería]
  plan_de_reversion: Volver al artefacto de la versión 1.3.2; la exportación no cambia datos.
  resultado: exitoso
  hora: 2030-03-04T16:20:00-06:00   # fecha ficticia de ejemplo

发布说明

R-029 的格式。工作项列表由工作项生成,而不是凭记忆书写。

nota_de_version:
  version: 1.4.0
  etiqueta: v1.4.0         # inmutable una vez publicada
  elementos_incluidos:
    - {id: TIE-12, titulo: Exportar pedidos a CSV}
    - {id: TIE-31, titulo: Corregir redondeo de totales}
  cambios_incompatibles: ninguno
  persona_que_autorizo: Ana
  fecha: 2030-03-04        # fecha ficticia de ejemplo

小组卡片

R-030 的格式。

ficha_de_cuadrilla:
  nombre: Exportaciones
  responsable: Ana
  integrantes:
    personas: [Beto]
    agentes:
      - nombre: asistente-de-codigo
        perfil: escribe código en las zonas de la cuadrilla
        alcance: [src/export/]
        presupuesto: desconocido   # se registra el dato cuando se mida
        supervisor: Beto
      - nombre: asistente-de-pruebas
        perfil: escribe pruebas
        alcance: [tests/]
        presupuesto: desconocido
        supervisor: Beto
  zonas: {src/export/: asistente-de-codigo, tests/: asistente-de-pruebas}
  tipos_de_trabajo_que_acepta: [función, corrección]

环境声明

R-027 的字段。示例中的分级方案是虚构的(公开、内部、机密、关键;由低到高),项目须声明自己的方案(MILPA-R-003)。合成数据或匿名化数据是一种实践,而不是等级中的层级。

entornos:
  - nombre: local
    proposito: desarrollar y probar
    valor_maximo_admitido: pública   # datos sintéticos
    origen_de_secretos: propios, sin valor real
    quien_despliega: quien trabaja
    comprobaciones_de_entrada: ninguna
  - nombre: integración
    proposito: comprobaciones automáticas de cada rama
    valor_maximo_admitido: pública   # datos sintéticos
    origen_de_secretos: almacén de secretos del proyecto, propios
    quien_despliega: proceso de integración continua
    comprobaciones_de_entrada: pruebas automáticas
  - nombre: preproducción
    proposito: probar la versión candidata
    valor_maximo_admitido: interna   # datos anonimizados
    origen_de_secretos: propios, distintos de producción
    quien_despliega: responsable de entrega
    comprobaciones_de_entrada: pruebas de integración
  - nombre: producción
    proposito: servir a las personas usuarias
    valor_maximo_admitido: crítica
    origen_de_secretos: propios, sólo accesibles al proceso de despliegue
    quien_despliega: responsable de entrega, con confirmación informada
    comprobaciones_de_entrada: artefacto con la huella comprobada; plan de reversión

分支模型声明

R-026 的字段以及 R-025 的约定。

modelo_de_ramas:
  rama_principal: principal
  proteccion: sólo se cambia por solicitud de integración revisada por una persona
  tipos_de_rama:
    - {prefijo: función/, patron: "función/<id>-<resumen>", ejemplo: función/TIE-12-exportar-csv}
    - {prefijo: corrección/, patron: "corrección/<id>-<resumen>", ejemplo: corrección/TIE-31-redondeo-de-totales}
  vida_maxima: 3 días hábiles
  una_rama_por_lote: sí
  quien_integra: Ana o la persona que ella designe; un asistente no escribe en la rama principal salvo mediante una solicitud de integración revisada por una persona; integrar lo catalogado como crítico lo decide una persona
  comprobaciones_antes_de_integrar: [pruebas automáticas, sincronía de versiones, exclusión de la capa de ingeniería]
  turno_en_rama_compartida: ninguna rama compartida declarada
  atribucion_en_cambios:
    mecanismo: trailers al final del mensaje (clave: valor)
    claves: [Refs, Lote, Co-authored-by, Responsable]

限制

模板不能取代要求:如果模板与要求不一致,以要求为准。一个文件具备全部字段,并不证明质量或真实性(见所引用各卡片的残余风险)。要把这些示例模板升级为经过检验的指南,验证方式是在真实项目中填写它们,并记录哪些字段缺失或多余(在此之前为 Hypothesis)。

返回 SCAFFOLD。