agentleFS
jeongskjeongsk/agenthub/skills/spec-implementation-notes/SKILL.md

spec-implementation-notes

Skill0 starsChanged 5 months agoMITView on GitHub

Maintain a live implementation-notes.md while implementing a feature from a SPEC. Records ambiguous design decisions, intentional deviations, tradeoffs, and open questions as they happen so the user can give feedback during implementation, not after. Use after grill-me, or whenever the user asks to implement a SPEC / specification / design doc / requirements. Triggers include "스펙 구현", "specification 따라 구현", "design doc 따라 구현해줘", "implement this spec", "build this from the spec".

The file

We split this skill into the rules it gives an agent

11 rules. About 0 are common, 5 are distinctive, and 6 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈5

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 6

    Very specific

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

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

    Use this skill when implementing a clarified <SPEC> — most commonly right after a grill-me session, but also any time the user says …

    line 10
  2. Very specific:

    Use HTML (implementation-notes.html) only when:

    line 24
  3. Distinctive:

    Default location: project root.

    line 38
  4. Very specific:

    Default git policy: do not commit the file.

    line 40
  5. Very specific:

    Never delete an entry. If a decision is reversed, transition it through changed and add a new entry — the audit trail is the point.

    line 78
  6. Distinctive:

    Read the SPEC and skim the codebase for likely ambiguity *before* writing code.

    line 82
  7. Distinctive:

    Update notes before or alongside the code change whenever:

    line 85
  8. Distinctive:

    Do not log routine edits (renames, formatting, obvious refactors).

    line 91
  9. Distinctive:

    Run, in order, whichever exist in the project:

    line 96
  10. Very specific:

    If a step does not exist or cannot be run, state that explicitly in the wrap-up.

    line 103
  11. Very specific:

    When invoked right after grill-me:

    line 116

≈ “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

Spec Implementation Notes

Use this skill when implementing a clarified <SPEC> — most commonly right after a grill-me session, but also any time the user says "implement this spec / design doc / requirements".

The goal is to keep implementation assumptions visible so the user can correct them mid-flight rather than after the fact.

Core Instruction

Implement the user's <SPEC>. While working, maintain a live notes file that records every meaningful point where the implementation differs from, interprets, or extends the specification.

The notes are a working artifact, not a final report. Update them as decisions happen.

File Format

Default: implementation-notes.md (Markdown).

Use HTML (implementation-notes.html) only when:

  • The user explicitly asks for HTML.
  • The artifact will be shared via a static-site / preview channel where Markdown rendering is unavailable.

Starter templates live next to this skill:

  • template.md — copy when creating the file the first time.
  • template.html — copy when the user opts into HTML.

Copy the relevant template verbatim into the project, then fill it in. Do not invent a new layout per project.

Where to Put the File

  • Default location: project root.
  • For monorepos, place it at the feature scope root (the package/app directory that owns the SPEC), not the repo root.
  • Default git policy: do not commit the file. On first creation, append implementation-notes.md (and .html if used) to the project's .gitignore. If the user later asks to commit it, remove the ignore entry — do not commit silently.

Required Sections

The notes file must contain these four sections (templates already include them):

SectionRecords
Design DecisionsChoices made because the spec was ambiguous
DeviationsPlaces where the implementation intentionally diverges from the spec, with reason
TradeoffsAlternatives considered and why the chosen approach won
Open QuestionsItems still needing confirmation; may force later changes

Entry Format

Each entry must include:

  • Title — short, scannable.
  • Status — see lifecycle below. Required.
  • Spec area / feature — which part of the SPEC this touches.
  • Timestamp — ISO 8601 with offset (e.g. 2026-05-25T14:30+09:00). Required, not optional.
  • Body — concise explanation, typically 1–4 sentences.

Status Lifecycle

open ──► accepted ──► resolved
              │
              └──► changed ──► accepted | resolved
StatusMeaning
openQuestion raised, no decision yet. Implementation is either blocked or proceeding on a stated assumption.
acceptedA decision/assumption is in force and the implementation reflects it. Still revisable.
changedA previously accepted decision was overturned. Record what changed and why, then add a follow-up entry with the new state.
resolvedThe user (or empirical evidence) confirmed the decision. No further change expected.

Never delete an entry. If a decision is reversed, transition it through changed and add a new entry — the audit trail is the point.

Workflow

  1. Read the SPEC and skim the codebase for likely ambiguity before writing code.
  2. Copy the starter template into the project and append the file to .gitignore (unless told otherwise).
  3. Seed the section headers, even if each section is initially empty.
  4. Update notes before or alongside the code change whenever:
    • The spec has multiple valid interpretations.
    • A user-visible behavior is chosen without explicit spec language.
    • Codebase constraints force a different implementation than the spec implies.
    • A simpler / staged / lower-risk approach is chosen over a richer alternative.
    • A question remains but implementation proceeds on a reasonable assumption.
  5. Do not log routine edits (renames, formatting, obvious refactors). Notes track judgments, not activity.
  6. At the end, summarize the implemented behavior and list every entry still in open status or recently changed.

Verification Before Declaring Done

Run, in order, whichever exist in the project:

  1. Type check (tsc, mypy, cargo check, etc.).
  2. Lint (eslint, ruff, cargo clippy, etc.).
  3. Tests relevant to the touched code.
  4. Build (if the project produces an artifact).

If a step does not exist or cannot be run, state that explicitly in the wrap-up. For behavioral verification (actually exercising the feature in a running app), delegate to the verify or run skill.

Completion Criteria

The task is complete when all of the following hold:

  • The SPEC implementation is done, or a clear blocker is recorded as an open entry.
  • implementation-notes.md (or .html) exists and reflects every known decision, deviation, tradeoff, and open question.
  • Verification appropriate to the project has been run, or its absence is stated explicitly.
  • The final response summarizes the implemented behavior and explicitly lists unresolved open items.

Default Starting Prompt

When invoked right after grill-me:

Implement the clarified SPEC. Maintain a live implementation-notes.md recording every meaningful point where the implementation differs from, interprets, or extends the specification. Use the sections, entry format, and status lifecycle defined in this skill. No spec is complete — surface ambiguities and unexpected constraints as you find them, and keep your assumptions visible for continuous feedback.

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.