agentleFS
BlockKnown publisherblock/trailblaze/.claude/skills/devlog/SKILL.md

devlog

Skill327 starsChanged 8 months agoApache-2.0View on GitHub

Write or update a devlog entry in the devlog directory. Use when the user asks to write a devlog, record a decision, document what happened, or says "write up what we did".

9 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

7 rules. 0 are common, 5 are distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 7 edited versions we read keep these.

  • 5

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Write or update a devlog entry in the devlog directory.

    line 8
  2. Distinctive:

    Use today's date and a short kebab-case topic slug.

    line 16
  3. Very specific:

    Use type: decision when recording a significant architectural or technical choice.

    line 51
  4. Distinctive:

    One entry per topic: Don't combine unrelated work.

    line 58
  5. Distinctive:

    Check existing devlog entries to avoid duplicating a topic

    line 62
  6. Distinctive:

    If updating an existing topic, consider appending to the existing entry rather than creating a new one

    line 63
  7. Very specific:

    When the user says /devlog, ask what topic to write about if it's not clear from context.

    line 68

“Common” is measured: kept by at least 6 in 10 of the 7 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

Devlog

Write or update a devlog entry in the devlog directory.

Devlog Format

Devlog entries are development journal posts that capture decisions, discoveries, and plans as work happens. They're written for the team — concise, honest, and useful for future reference.

Filename: YYYY-MM-DD-<topic-slug>.md

Use today's date and a short kebab-case topic slug.

Entry Structure

---
title: "Short Descriptive Title"
type: devlog
date: YYYY-MM-DD
---

# Title

## Summary
1-3 sentences on what this entry covers.

## <Sections as needed>
Use whatever sections make sense for the content. Common ones:
- What Changed
- Key Decisions (and rationale)
- What We Learned
- Open Questions
- Future Work

Keep it direct. No filler. Write like you're explaining to a teammate who will read this in 3 months.

Front Matter Fields

FieldRequiredValues
titleYesShort descriptive title
typeYesdecision (architectural/technical choice) or devlog (development note)
dateYesYYYY-MM-DD format

Use type: decision when recording a significant architectural or technical choice. Use type: devlog for development notes, debugging sessions, and implementation details.

Guidelines

  • Be opinionated. Capture why decisions were made, not just what happened.
  • Include the dead ends. What didn't work and why is often more valuable than what did.
  • Link to context. Reference PRs, branches, test names, file paths — make it traceable.
  • One entry per topic. Don't combine unrelated work. Multiple entries on the same day is fine.

Before Writing

  1. Check existing devlog entries to avoid duplicating a topic
  2. If updating an existing topic, consider appending to the existing entry rather than creating a new one
  3. Review the current conversation context for decisions, discoveries, and rationale worth capturing

Invocation

When the user says /devlog, ask what topic to write about if it's not clear from context. If you've been working on something substantial in the current session, suggest writing about that.

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.