agentleFS
mattmirelesmattmireles/gemma-tuner-multimodal/.claude/skills/write-notes/SKILL.md

write-notes

Skill1.5k starsChanged 4 days agoMITView on GitHub

Write or update repo notes (prefer README/notes/debug-notes.md in this repo, or README/Notes if present). Use when the user wants debugging notes, investigation notes, audit notes, or institutional memory captured in the repo. Prefer updating the right high-level notes document over creating a fresh file for every session. Do not use for plans, long-form guides, or inline code comments.

We split this skill into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈8

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Read references/index.md first.

    line 28
  2. Distinctive:

    update the right high-level domain note file

    line 31
  3. Distinctive:

    add a new issue section inside that file

    line 32
  4. Distinctive:

    keep the issue self-contained with the notes-template structure

    line 33
  5. Distinctive:

    Create a new notes file only when the topic is durable enough to deserve its own entry point:

    line 34
  6. Distinctive:

    Use topic-based names for new files.

    line 39
  7. Distinctive:

    Keep the note high signal:

    line 41
  8. Distinctive:

    Keep active issues near the top.

    line 48

≈ “Common” is an estimate: at least 1 in 5 of the 308,232 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

Write Notes

Purpose

Capture useful institutional memory without creating note sprawl. In gemma-tuner-multimodal, default to README/notes/debug-notes.md unless the repo already uses another agreed layout.

Use When

  • The user wants a bug, investigation, audit, or debugging trail captured in repo notes.
  • A change should leave behind durable troubleshooting context.
  • An existing notes bundle should be updated with a new issue section.

Do Not Use When

  • The user wants a plan.
  • The output belongs in a guide or README.md instead of session notes.
  • The content is really inline code documentation.
  • The note would be throwaway session chatter with no lasting value.

Procedure

  1. Read references/index.md first.
  2. Scan README/notes/debug-notes.md and, if present, README/Notes/ for the best existing home before creating any new file.
  3. Default to consolidation:
    • update the right high-level domain note file
    • add a new issue section inside that file
    • keep the issue self-contained with the notes-template structure
  4. Create a new notes file only when the topic is durable enough to deserve its own entry point:
    • recurring subsystem problem
    • cross-cutting audit
    • report likely to be searched directly later
  5. Use topic-based names for new files. Do not create a new file just because there is a new date or session.
  6. Keep the note high signal:
    • summary
    • symptom
    • root cause or TBD
    • related guides
    • fix or current status
    • verification or next step
  7. Keep active issues near the top. Convert fixed issues to resolved status and prune dead investigation branches after resolution.

References

Read references/index.md first.

Handoff Rules

  • Hand off to markdown when the real task is markdown cleanup rather than note placement or note structure.
  • Hand off to create-plan when the user wants a real implementation plan instead of notes.

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.