agentleFS
Industrial-AI-Research-LabIndustrial-AI-Research-Lab/nir-agent-overlay/skills/write-adr/SKILL.md

write-adr

Skill0 starsChanged 45 days agoMITView on GitHub

Draft an architecture decision record (ADR) in docs/adr/ from the discussion, the PR thread and the code. Use when the student says "запиши решение", "сделай ADR", "write an ADR", or when a decision changes structure, tooling, data, metric or baseline.

12 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use code-review.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • GoogleSkill

    code-review

    Adversarial systems, concurrency, memory-model, and architecture code review protocol. Use this skill whenever asked to review code, PRs, diffs, or branches in Filament.

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

1 rule. 0 are common, 0 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 12 edited versions we read keep these.

  • 0

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    If the record supersedes an older one: the old status becomes superseded by ADR-NNNN and the two files link to each other.

    line 15

“Common” is measured: kept by at least 6 in 10 of the 12 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

write-adr

  1. Find the next number: the highest NNNN in docs/adr/ plus one; never reuse a number.
  2. Copy docs/adr/0000-template.md to docs/adr/NNNN-<short-title>.md; the title names the problem and the chosen solution.
  3. Fill the sections from the sources you have: the conversation, the PR thread, the code, the MLflow experiment or run that motivated the decision (link it). Status proposed, today's date, decision-makers the student, consulted the supervisor.
  4. Considered options: at least two. When an option suggested by the supervisor is rejected, fill "Pros and cons of the options" with the reason.
  5. If the record supersedes an older one: the old status becomes superseded by ADR-NNNN and the two files link to each other. Change nothing else in an accepted record.
  6. Show the file to the student for review. It is committed in the feature branch and becomes accepted in the same PR before merge.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.