alt-adr-writer

Write Japanese ADRs and run Pact-gated production deploys for Alt.

9|4|Updated May 30, 2025
One-click install
npx skills add https://github.com/Kaikei-e/Alt --skill alt-adr-writer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: alt-adr-writer
Source: https://github.com/Kaikei-e/Alt/tree/main/.claude/skills/alt-adr-writer
Command: npx skills add https://github.com/Kaikei-e/Alt --skill alt-adr-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Prevents informal or undocumented architectural decisions by producing a standardized, Japanese-language Architecture Decision Record tied to the exact working implementation and optionally performing a Pact-gated production deploy to ensure the recorded state is reproducible.

Core Features & Use Cases

  • Automated verification: Runs minimum tests and rebuilds only affected services to confirm the implementation is green before documenting.
  • ADR creation: Creates a new docs/ADR/NNNNNN.md using the project's template, enforces frontmatter fields and Obsidian-style wikilinks, and writes the content in Japanese following the template sections.
  • Gated deployment: Commits ADR alongside code and executes the repository deploy workflow (./scripts/deploy.sh production) with Pact checks and healthchecks; supports skip flags for ADR-only or docs-only flows.
  • Use case: After finishing a feature in the Alt monorepo, produce a discoverable ADR, validate the runtime behavior, and carry out the controlled production deploy.

Quick Start

Say ADR書いて to generate a Japanese ADR for the recent change, run the minimum tests and rebuild affected services, create docs/ADR/NNNNNN.md and commit it with the code, then execute ./scripts/deploy.sh production unless you explicitly request ADR-only.

Frequently Asked Questions about alt-adr-writer

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

FAQPage Schema
How do I automate creating a Japanese Architecture Decision Record after finishing a feature?

A Japanese Architecture Decision Record should be created after finishing a feature in a monorepo to prevent informal architectural decisions. It produces a standardized, discoverable record tied to the exact working implementation and validates runtime behavior before deployment.

How to run a Pact-gated production deploy with automated ADR creation?

Running a Pact-gated production deploy with ADR creation requires executing ./scripts/deploy.sh production after committing the Japanese ADR. The workflow enforces Pact checks and healthchecks, running minimum tests and rebuilding affected services to ensure the recorded state is reproducible.

Can I generate an ADR without triggering a production deploy?

You can generate an ADR without a production deploy by requesting an ADR-only flow. The workflow supports optional skips per user flags, allowing documentation generation without executing the repository deploy script or running Pact checks.

What prerequisites are needed to write Japanese ADRs and run Pact-gated deploys?

Prerequisites for writing Japanese ADRs and running Pact-gated deploys include having repository bash scripts and local tooling available. The workflow requires completed code changes in the monorepo and applies to environments where ./scripts/deploy.sh production can execute successfully.

Why does my ADR deployment workflow fail validation checks?

ADR deployment workflows fail validation when minimum tests are not green or affected services fail to rebuild. The workflow enforces test and healthcheck validation before creating the ADR, ensuring the recorded architectural state matches the validated runtime behavior.