030-architecture-adr-general

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Java ADR Generator with interactive conversational approach

采用交互式对话方式的Java ADR生成工具

Generate Architecture Decision Records (ADRs) for Java projects through an interactive, conversational process that systematically gathers all necessary context to produce well-structured ADR documents. This is an interactive SKILL.
What is covered in this Skill?
  • ADR file storage configuration
  • Conversational information gathering: context, stakeholders, decision drivers, options with pros/cons, outcome, consequences
  • MADR template generation
  • Validation with
    ./mvnw validate
    or
    mvn validate
    before proceeding
为Java项目通过交互式对话流程生成架构决策记录(ADRs),该流程会系统地收集所有必要的背景信息,以生成结构清晰的ADR文档。这是一个交互式SKILL
本Skill涵盖哪些内容?
  • ADR文件存储配置
  • 对话式信息收集:背景信息、相关人员、决策驱动因素、带有优缺点的可选方案、结果、影响
  • MADR模板生成
  • 继续操作前使用
    ./mvnw validate
    mvn validate
    进行验证

Constraints

约束条件

Before applying any ADR generation, ensure the project validates. If validation fails, stop immediately — do not proceed until all validation errors are resolved.
  • MANDATORY: Run
    ./mvnw validate
    or
    mvn validate
    before applying any ADR generation
  • SAFETY: If validation fails, stop immediately — do not proceed until all validation errors are resolved
  • BEFORE APPLYING: Read the reference for detailed good/bad examples, constraints, and safeguards for each ADR generation pattern
在进行任何ADR生成之前,请确保项目验证通过。如果验证失败,请立即停止——在解决所有验证错误之前不要继续。
  • 强制要求:在进行任何ADR生成之前运行
    ./mvnw validate
    mvn validate
  • 安全要求:如果验证失败,请立即停止——在解决所有验证错误之前不要继续
  • 操作前须知:查阅参考文档,了解每种ADR生成模式的详细优劣示例、约束条件和防护措施

When to use this skill

何时使用本Skill

  • Generate ADR
  • Create Architecture Decision Record
  • Document architecture decision
  • Architecture Decision Record for Java
  • Write ADR
  • Document technical decision
  • Architecture documentation
  • Record design decision
  • Technology choice documentation
  • Framework selection ADR
  • Database choice ADR
  • Architectural trade-offs
  • Technical alternatives evaluation
  • Why did we choose
  • Deployment strategy ADR
  • Infrastructure choice
  • Vendor selection ADR
  • 生成ADR
  • 创建架构决策记录
  • 记录架构决策
  • Java项目架构决策记录
  • 编写ADR
  • 记录技术决策
  • 架构文档编写
  • 记录设计决策
  • 技术选型文档
  • 框架选型ADR
  • 数据库选型ADR
  • 架构权衡分析
  • 技术备选方案评估
  • 选型原因记录
  • 部署策略ADR
  • 基础设施选型
  • 供应商选型ADR

Reference

参考资料

For detailed guidance, examples, and constraints, see references/030-architecture-adr-general.md.
如需详细指南、示例和约束条件,请查看references/030-architecture-adr-general.md