adr-manage

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Skill: adr-manage

Skill: adr-manage

Crea y actualiza Architecture Decision Records siguiendo el flujo de este documento.
Alcance de un ADR: registrar la decisión y su justificación — no la implementación. Puede incluir ejemplos, diagramas y referencias externas de apoyo.
La plantilla canónica está en
assets/adr-template.md
. Leerla antes de redactar cualquier ADR.

创建并更新Architecture Decision Records(ADRs),遵循本文档流程。
ADR的范围:记录决策及其理由——而非实现细节。 可包含示例、图表及辅助性外部参考资料。
标准模板位于
assets/adr-template.md
。撰写任何ADR前请先阅读该模板。

Idioma del contenido

内容语言优先级

Resolver en este orden (detenerse en el primer match):
  1. preferred language: <ISO>
    en
    .agents/MEMORY.md
  2. Idioma del mensaje actual del usuario
  3. Preguntar al usuario y persistir en
    .agents/MEMORY.md

按以下顺序确定(匹配到第一个即停止):
  1. .agents/MEMORY.md
    中的
    preferred language: <ISO>
    配置
  2. 用户当前消息的语言
  3. 询问用户并将结果保存到
    .agents/MEMORY.md

Información requerida antes de redactar

撰写前需收集的信息

Recopilar en una sola tanda de preguntas al inicio usando la herramienta de opciones tappables del cliente (máx. 3 preguntas por bloque; opciones cortas y mutuamente excluyentes). No inventar datos — si no están en contexto, preguntar.
DatoFuente preferidaSi no está
Problema / tensión arquitectónicaDescripción del usuarioPreguntar
Decisión concretaDescripción del usuarioPreguntar
DecisoresIndicado por el usuarioPreguntar siempre
Stack tecnológico
package.json
,
pom.xml
, etc.
Preguntar
Alternativas consideradasSolo si el usuario las mencionóOmitir la sección si no las mencionó
ADRs o docs relacionados
docs/adr/
+ contexto
Preguntar si hay referencias a citar
ADRs en estado Draft o Proposed también requieren problema y decisión tentativa.

使用客户端的可点击选项工具,在初始阶段一次性提问(每组最多3个问题;选项简短且互斥)。不得编造数据——若上下文未提供,需询问用户。
信息首选来源若未提供
架构问题/矛盾用户描述询问用户
具体决策用户描述询问用户
决策者用户指定必须询问
技术栈
package.json
pom.xml
等文件
询问用户
考虑过的替代方案仅当用户提及若未提及则省略该部分
相关ADRs或文档
docs/adr/
+ 上下文
询问是否有需引用的参考资料
处于DraftProposed状态的ADR也需提供问题和暂定决策。

Validación de conflictos (solo al crear)

冲突验证(仅创建时)

Antes de redactar un ADR nuevo:
  1. Leer títulos y sección
    ## Decision
    de todos los ADRs existentes en
    docs/adr/
  2. Si hay conflicto (misma tecnología/componente ya
    Accepted
    , contradicción directa, o duplicación de alcance):
    • No redactar; informar al usuario con enlace(s) al ADR en conflicto
    • Sugerir: (a) actualizar el existente, (b) crear nuevo marcando el anterior como
      Superseded
      , o (c) ajustar el alcance

撰写新ADR前:
  1. 阅读
    docs/adr/
    中所有现有ADR的标题和
    ## Decision
    部分
  2. 若存在冲突(相同技术/组件已处于
    Accepted
    状态、直接矛盾或范围重复):
    • 请勿撰写;告知用户并提供冲突ADR的链接
    • 建议:(a) 更新现有ADR,(b) 创建新ADR并将原ADR标记为
      Superseded
      ,或(c) 调整范围

Flujo: Crear ADR nuevo

流程:创建新ADR

  1. Número secuencial — listar
    docs/adr/ADR-*.md
    , tomar el más alto + 1; si no hay ninguno, empezar en
    001
    . Nunca pedir el número al usuario.
  2. Nombre de archivo
    ADR-XXX-<slug>.md
    (minúsculas, kebab-case, corto)
  3. Recopilar información faltante (ver tabla anterior)
  4. Escribir el ADR desde
    assets/adr-template.md
    :
    • Fecha de creación
      = hoy;
      Última actualización
      = hoy
    • Estado por defecto:
      Draft
  5. Actualizar
    docs/adr/README.md
    :
    • Si no existe, crearlo con encabezado y lista vacía
    • Añadir
      - [ADR-XXX: Título](ADR-XXX-slug.md)
      en orden ascendente
    • Nunca reordenar ni eliminar entradas existentes
  6. Confirmar mostrando ruta del ADR y la línea añadida al README

  1. 序列号——列出
    docs/adr/ADR-*.md
    文件,取最大编号+1;若无任何ADR,则从
    001
    开始。切勿向用户索要编号。
  2. 文件名——
    ADR-XXX-<slug>.md
    (小写、短横线分隔格式、简短)
  3. 收集缺失信息(见上表)
  4. 基于
    assets/adr-template.md
    撰写ADR
    • 创建日期 = 今日;最后更新日期 = 今日
    • 默认状态:
      Draft
  5. 更新
    docs/adr/README.md
    • 若该文件不存在,则创建带标题和空列表的文件
    • 按升序添加
      - [ADR-XXX: 标题](ADR-XXX-slug.md)
    • 切勿重新排序或删除现有条目
  6. 确认——展示ADR路径及添加到README的行内容

Flujo: Actualizar ADR existente

流程:更新现有ADR

  1. Identificar el archivo por número, slug o título
  2. Leer el contenido completo antes de editar
  3. Aplicar los cambios; actualizar
    Última actualización
    a hoy; nunca tocar
    Fecha de creación
  4. Si el nuevo estado es
    Superseded
    : agregar en
    ## Referencias
    :
    - Superseded by: [ADR-XXX: Título](docs/adr/ADR-XXX-slug.md)
    Si el usuario no indicó el ADR reemplazante, preguntar antes de guardar.
  5. Actualizar
    docs/adr/README.md
    si el título cambió
  6. Confirmar mostrando los campos modificados

  1. 通过编号、slug或标题确定目标文件
  2. 编辑前完整阅读内容
  3. 应用更改;将最后更新日期改为今日;切勿修改创建日期
  4. 若新状态为
    Superseded
    :在
    ## 参考资料
    中添加:
    - Superseded by: [ADR-XXX: 标题](docs/adr/ADR-XXX-slug.md)
    若用户未指定替代ADR,保存前需询问用户。
  5. 若标题更改,更新
    docs/adr/README.md
  6. 确认——展示修改的字段

Convenciones de metadatos

元数据规范

CampoRegla
Estado
Draft
·
Proposed
·
Accepted
·
Deprecated
·
Superseded
Fecha de creación
Fecha real de creación — nunca modificar
Última actualización
Fecha de hoy en cada escritura
Decisores
Nombres o roles
Etiquetas
Palabras clave (tecnología, dominio)

字段规则
状态
Draft
·
Proposed
·
Accepted
·
Deprecated
·
Superseded
创建日期实际创建日期——切勿修改
最后更新日期每次撰写时设为今日
决策者姓名或角色
标签关键词(技术、领域)

Referencias

参考资料