agentleFS
rubber-ducks-syndicaterubber-ducks-syndicate/obsidian-documentation-skill/skills/obsidian-doc-prompter/SKILL.md

obsidian-doc-prompter

Skill0 starsChanged 5 months agoMITView on GitHub

Documentation reflex for coding sessions. Consult this skill whenever you have just implemented, modified, refactored, or fixed something in a project — a feature, an endpoint, a component, a schema change, an architectural change, a dependency swap — even if the user never mentioned documentation. It checks whether the change is worth documenting, asks the user, and on yes hands a pre-approved scope to the obsidian-documentation orchestrator. It never documents without consent.

The file

We split this skill into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    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:

    Read ../obsidian-documentation/references/conventions.md for project-scope rules.

    line 10
  2. Distinctive:

    After completing a meaningful unit of coding work in a conversation: new feature or capability, changed behavior of an existing one, …

    line 14
  3. Distinctive:

    Keep it to 3–5 lines. The affected-notes list is the value — it shows the user what's drifting out of date.

    line 33

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

Documentation Prompter

You are the bridge between coding work and the vault. Code changes are where documentation debt is born — this skill catches the moment when context is still fresh and offers to capture it. You ask; you never document uninvited.

Read ../obsidian-documentation/references/conventions.md for project-scope rules.

When to fire

After completing a meaningful unit of coding work in a conversation: new feature or capability, changed behavior of an existing one, schema/API changes, architectural moves (new service, swapped dependency, infra change), or a decision made along the way ("let's use X instead").

Stay quiet for trivial changes: typo fixes, formatting, version bumps, small refactors with no behavior change, experiments the user called throwaway. A prompt after every commit is noise that trains the user to say no. When unsure, lean quiet — the user can always invoke documentation explicitly.

Also stay quiet if the user already declined to document this same change earlier in the conversation. Once per change, maximum.

What to do

  1. Size up the change. From the conversation and diff, identify what changed and whether existing vault notes are affected (quick check of the project folder — grep -ril "<topic>" <vault>/<Project>/; if there's no project folder yet, note that this would be its first documentation).
  2. Make a concrete, small offer. Not "want docs?" but what would actually happen:

    This added a refund endpoint and UI. Want me to document it? That would mean:

    • update Features/Payments/Payment Processing.md (refund section)
    • new Features/Refunds/ note + sequence diagram
    • possibly an ADR — we chose manual review for refunds > $500

    All / some / skip?

    Keep it to 3–5 lines. The affected-notes list is the value — it shows the user what's drifting out of date.

  3. On yes (or partial): invoke the obsidian-documentation orchestrator (../obsidian-documentation/SKILL.md) with the approved scope: which items, the change summary, the diff range, and the resolved project folder. The orchestrator takes over from there — don't write notes yourself.
  4. On no: drop it gracefully. Optionally, if the change made existing notes wrong (not just incomplete), say so in one line — "FYI, Payment Processing.md now describes the old flow" — and leave it.

Rules

  • Consent first, always. No silent vault writes from a coding session.
  • One prompt per change, at a natural pause (work finished), never mid-task.
  • The offer must name affected existing notes when there are any — that's what makes it worth interrupting.
  • You do not create or update any documentation yourself; you only scope and hand off to the orchestrator.

Making it automatic (optional)

Skill triggering depends on Claude noticing. If the user mentions missed documentation prompts, point out the option of adding one line to the project's CLAUDE.md ("After completing any meaningful code change, consult the obsidian-doc-prompter skill."). Don't suggest it unprompted — some users deliberately keep project CLAUDE.md files free of such entries.

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.