ada-adr-authoring

Writes bilingual architecture decision records with verified API signatures and SRS anchors.

Updated Jul 23, 2026
One-click install
npx skills add https://github.com/wubing7755/Ada --skill ada-adr-authoring-wubing7755
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ada-adr-authoring
Source: https://github.com/wubing7755/Ada/tree/main/skills/software-development/ada-adr-authoring
Command: npx skills add https://github.com/wubing7755/Ada --skill ada-adr-authoring-wubing7755

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Architecture decisions in bilingual projects often get recorded inconsistently, with invented API signatures, stale SRS line references, and out-of-sync English/Chinese documents. This Skill enforces a verified, repeatable ADR authoring workflow so every decision record is accurate, traceable, and reviewable. ## Core Features & Use Cases - Mandatory ADR Structure: Enforces the six-section format (Context, Decision, Alternatives, Consequences, Verification, Supersession) with frontmatter status gating at Proposed until maintainer approval. - Source-Verified Authoring: Requires checking real framework source code for API signatures and grepping actual SRS requirement IDs before citing them, preventing compile-breaking or mis-anchored ADRs. - Bilingual Synchronization: Produces the English canonical ADR plus Chinese translation, updates both README index tables, and runs an identifier-consistency diff between the pair. - Use Case: When a public API change needs an ADR, the Skill reads the real contract code, drafts the decision with alternatives and explicit supersession statements, prepares a numbered maintainer decision list with recommended defaults, and keeps both language versions in sync. ## Quick Start Ask the agent to write an ADR for a proposed architecture change, verifying the real API signatures and SRS anchors first and producing both the English and Chinese versions with updated README indexes.

Frequently Asked Questions about ada-adr-authoring

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write an architecture decision record for a public API change?

Read the most similar existing ADR to mirror its format, verify the real API signatures in source code before writing candidate shapes, then fill the six mandatory sections: Context, Decision, Alternatives, Consequences, Verification, and Supersession. Set Status to Proposed until the maintainer approves.

What sections must an ADR contain?

Each ADR must contain Context, Decision, Alternatives, Consequences, Verification, and Supersession sections, plus frontmatter with Status, Date, Decision maker, and Related fields. Changing an Accepted ADR requires writing a new ADR rather than rewriting history.

How do I keep English and Chinese ADR versions synchronized?

Write the English canonical version first, then the Chinese translation preserving decision IDs, code identifiers, enum values, and must/should/may strength words. Run a diff on extracted identifiers between both files and update both README index tables before committing.

Why does an ADR cause compile errors after implementation?

This happens when candidate API signatures are invented instead of verified against actual source code. Always read the real contract first, checking parameter counts and internal versus public visibility, since a single-argument call fails when the method requires two parameters.

When should an ADR status change from Proposed to Accepted?

Only the maintainer can approve a status change to Accepted. Drafts remain Proposed, and the README index row must reflect Proposed until the maintainer confirms the numbered decision list and the decisions are baked into the ADR.