agentleFS
Sign inStart free
orrozenorrozen/cdd-starter/skills/update-design-log/SKILL.md

update-design-log

Skill0 starsChanged 6 days agoMITView on GitHub

Update the design log from a discussion. Turn a pasted meeting summary, chat thread or PR review into a new dated design-log entry, or append Implementation Results to an existing one. Use when the user says "update the design log", "log this decision", "write this up as a design log", or "add implementation results".

The file

We split this skill into the rules it gives an agent

3 rules. About 0 are common, 0 are distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

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

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

    Ask which project, unless it's clear.

    line 12
  2. Very specific:

    Q&A: every question raised goes in, with its answer.

    line 25
  3. Very specific:

    Implementation Results: start with _Appended YYYY-MM-DD.

    line 26

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “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

Update design log

Turn a discussion the user pastes into a design-log change that follows the repo rules in AGENTS.md.

1. Find the project and the log

  • Ask which project, unless it's clear. Read projects/<project>/INTRO.md.
  • Grep projects/<project>/design-log/ for the topic. Decide:
    • No related log → new entry.
    • Related log, implementation not started → edit that log's design sections.
    • Related log, implementation started → append ## Implementation Results. Don't touch the sections above it.

2. Filter with the newcomer test

From the pasted text, keep only what a smart newcomer would undo without knowing why: decisions, rejected options and reasons, constraints, surprises. Drop status chatter, names of who said what, and anything already obvious from the code.

3. Write it

  • New entry: copy templates/design-log.md to design-log/YYYY-MM-DD-<short-slug>.md (today's date). Fill Background, Problem, Q&A, Design, Trade-offs. Leave sections empty rather than invent content.
  • Q&A: every question raised goes in, with its answer. Unanswered questions stay, marked **A:** open.
  • Implementation Results: start with _Appended YYYY-MM-DD. The design above is frozen._, then what shipped, what changed and why, surprises, follow-ups.
  • Links, not copies: reference tickets, designs and PRs by link. Don't paste their content.
  • Length: about 80 lines at most. Move long detail to dev/<slug>.md and link it.

4. Check with the user

Show the diff. List anything you left out and why, and any open questions. Then remind the user to commit.

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.

Check your setup, free