agentleFS
waynesuttonwaynesutton/markdown-site/.cursor/skills/update-project-docs/SKILL.md

update-project-docs

Skill628 starsChanged 7 months agoMITView on GitHub

Use this skill after completing any feature, fix, or migration to keep the three core project tracking files in sync. Activate with: @update Run this first: Use actual commit dates. Never use placeholder dates or future months. Move completed items into ## Completed with the date: Add a session update note at the top of ## Current Status: If new work is queued, add it under ## To Do. Follow https://keepachangelog.com/en/1.0.0/ format. Add the new entry at the top under…

5 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

10 rules. 0 are common, 6 are distinctive, and 4 are very specific to this project.

  • 0

    Common

    Most of the 4 edited versions we read keep these.

  • 6

    Distinctive

    This author's own choices. Worth a look.

  • 4

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use this skill after completing any feature, fix, or migration to keep the three core project tracking files in sync.

    line 3
  2. Distinctive:

    Use actual commit dates. Never use placeholder dates or future months.

    line 15
  3. Very specific:

    Add a session update note at the top of ## Current Status:

    line 27
  4. Very specific:

    If new work is queued, add it under ## To Do.

    line 33
  5. Very specific:

    Follow https://keepachangelog.com/en/1.0.0/ format.

    line 37
  6. Distinctive:

    Only update if new files were added or if existing file descriptions are outdated.

    line 58
  7. Distinctive:

    Add new files to the correct table section

    line 60
  8. Distinctive:

    Keep descriptions to 1-2 sentences, no emoji

    line 61
  9. Distinctive:

    Before calling this done, confirm:

    line 66
  10. Very specific:

    Do not create README.md, CONTRIBUTING.md, or other documentation files unless explicitly requested.

    line 76

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

Update project docs

Use this skill after completing any feature, fix, or migration to keep the three core project tracking files in sync.

Activate with: @update

Step 1: Get real dates

Run this first:

git log --date=short -n 10

Use actual commit dates. Never use placeholder dates or future months.

Step 2: Update TASK.md

Move completed items into ## Completed with the date:

- [x] Feature name (YYYY-MM-DD)
  - [x] Sub-task detail
  - [x] Sub-task detail

Add a session update note at the top of ## Current Status:

Session updates complete on YYYY-MM-DD.

If new work is queued, add it under ## To Do.

Step 3: Update changelog.md

Follow https://keepachangelog.com/en/1.0.0/ format. Add the new entry at the top under ## [Unreleased] or as a versioned release:

## [vX.Y.Z] - YYYY-MM-DD

### Added
- Feature name with key details

### Fixed
- Bug description and resolution

### Changed
- What changed and why

Version increment guide (check existing version in changelog.md first):

  • New feature: bump minor (2.20.x -> 2.21.0)
  • Bug fix or small improvement: bump patch (2.20.0 -> 2.20.1)

Step 4: Update files.md

Only update if new files were added or if existing file descriptions are outdated.

  • Add new files to the correct table section
  • Keep descriptions to 1-2 sentences, no emoji
  • Focus on what the file does and any key implementation details

Checklist

Before calling this done, confirm:

  • git log --date=short run to get real dates
  • TASK.md completed section updated with date and sub-items
  • changelog.md new entry added with real version and date
  • files.md updated if new files exist

Notes

  • This skill applies to this project. If the project you are working on does not have these exact files, adapt the steps to whatever tracking files exist.
  • Do not create README.md, CONTRIBUTING.md, or other documentation files unless explicitly requested.

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.