Agent skill

Project Docs

by waynesutton in waynesutton/builder-skills

Brings task.md, changelog.md, and files.md back in sync with what the code says shipped.

Apache-2.0Auto-check: notesDevelopment

Install Project Docs

skills CLI
$ npx skills add waynesutton/builder-skills --skill project-docs -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install waynesutton/builder-skills project-docs --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/waynesutton/builder-skills.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/project-docs .claude/skills/project-docs && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
project-docs
GitHub stars
404
Token cost
~1.3k tokens
SKILL.md length
688 words
Files
6 (incl. references, assets)
Skills in repo
17
Repo updated
First seen
Licence
Apache-2.0

At a glance

Brings task.md, changelog.md, and files.md back in sync with what the code says shipped.

  • Works in 7 steps: Find the root. git rev-parse… → Collect evidence. git log --date=short… → Read all three files as they are. Note… → …
  • The user says update the docs
  • SKILL.md covers Run the sync, task.md, changelog.md and files.md, plus 4 more sections
  • Calls git

What it does

Project Docs is an agent skill from waynesutton/builder-skills. Brings task.md, changelog.md, and files.md back in sync with what the code says shipped. Reads git history and the working tree, never memory, and refuses to log features it cannot see in source. Use when a feature or fix lands, when the user says "update the docs", "sync changelog", "update files.md", "@update", or when task.md and the code disagree.

Its SKILL.md is about 1.3k tokens, which your agent loads only when the skill is triggered. The skill folder holds 8 other files, including reference files and assets (for example `agents/openai.yaml`, `references/convex-detection.md` and `references/evidence-rules.md`).

It sits in Development, covering Changelog and release notes and Git workflow. It works with Git. The repository describes itself as: Builder skills for Convex apps. Convex patterns plus a PRD, task.md, changelog, and files.md workflow for Claude Code, Codex, Cursor, and OpenCode. The licence is Apache-2.0.

When your agent uses it

  • The user says update the docs
  • Update files.md
  • Task.md and the code disagree

Example prompts

  • “update the docs”
  • “sync changelog”
  • “update files.md”
  • “/project-docs”

Workflow steps

7 steps, taken from the first numbered list in SKILL.md.

  1. Find the root. git rev-parse --show-toplevel, or the workspace root without git.
  2. Collect evidence. git log --date=short -n 20, git status --short, git diff --stat, and for the current change git diff HEAD --stat or the…
  3. Read all three files as they are. Note the last logged date and the last completed task.
  4. Update each file. Rules below.
  5. Check idempotency. If nothing new landed since the last entry, change nothing and say so.
  6. Scan for secrets and personal data before saving. See the redaction section.
  7. Report in a few lines. Show the new changelog entry or say the docs were already current.

What it can do on your machine

Read from SKILL.md and the folder at commit 82d1ce2. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • git

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md. Its commands use git, which can reach the network depending on how they are called.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Project Docs loads about 1.3k tokens when it runs, and up to ~2.9k if it reads all its reference files. Until then it costs about 92 tokens; SKILL.md has 688 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~92
When it runs · the whole SKILL.md, loaded when a task matches
~1.3k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~2.9k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check: notes

The automated check noted patterns worth knowing about, such as sudo or a known installer.

  • NoteMentions a .env fileSKILL.md:83
    - Never open `.env`, `.env.local`, or any secret store to fill in a doc. Env var names are fine to mention. Values never

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from waynesutton/builder-skills at commit 82d1ce2, republished under its Apache-2.0 licence (© waynesutton). 688 words, ~1,345 tokens.

Download SKILL.mdSave it as .claude/skills/project-docs/SKILL.md (or your agent's skills folder). This skill also uses 5 other files; get the full folder from GitHub.
name
project-docs
description
Brings task.md, changelog.md, and files.md back in sync with what the code says shipped. Reads git history and the working tree, never memory, and refuses to log features it cannot see in source. Use when a feature or fix lands, when the user says "update the docs", "sync changelog", "update files.md", "@update", or when task.md and the code disagree.

Project docs

Three files describe a project to the next person who opens it. Keep them true.

FileAnswers
task.mdWhat is planned, in flight, and done
changelog.mdWhat changed for users, by version and date
files.mdWhat each file is for

Truth comes from the repo, not from the conversation. If the diff does not show it, it did not ship.

Run the sync

  1. Find the root. git rev-parse --show-toplevel, or the workspace root without git.
  2. Collect evidence. git log --date=short -n 20, git status --short, git diff --stat, and for the current change git diff HEAD --stat or the staged diff. See references/evidence-rules.md for what counts.
  3. Read all three files as they are. Note the last logged date and the last completed task.
  4. Update each file. Rules below.
  5. Check idempotency. If nothing new landed since the last entry, change nothing and say so.
  6. Scan for secrets and personal data before saving. See the redaction section.
  7. Report in a few lines. Show the new changelog entry or say the docs were already current.

task.md

Sections: ## To Do, ## In Progress, ## Completed.

  • Move an item to Completed only if its verification step ran. If the PRD lists a check that has not run, leave it In Progress and say which check is pending.
  • Completed entries: - [x] YYYY-MM-DD HH:mm UTC <what>. <PRD path if any>. <files touched>. Verified: <command or outcome>.
  • Never delete history. Old completed items stay.
  • If task.md does not exist, create it with the three headings and the current change under Completed or In Progress based on the evidence.

changelog.md

Keep a Changelog format. ## [Unreleased] at the top, then ## [x.y.z] - YYYY-MM-DD blocks, each with ### Added, ### Changed, ### Fixed, ### Removed as needed.

  • Dates come from git log --date=short. The release date is the date of the commit that bumped the version, or today's UTC date if it has not been committed yet. Never a placeholder, never a future month.
  • Write for the user of the project, not the author. "Uploads over 5 MB now show a progress bar" beats "refactored upload hook".
  • One line per change. Group related commits.
  • Do not log dependency bumps, formatting, or generated files unless they change behavior.
  • If a version bump exists in package.json with no matching heading, add the heading.

files.md

One line per file that matters. Grouped by folder.

## convex/
- `schema.ts` tables and indexes
- `stats.ts` heartbeat mutation with 10s dedup window, page view inserts

## src/hooks/
- `usePageTracking.ts` sends heartbeats, debounced 5s, path change aware
  • Add every new source file from the diff.
  • Fix descriptions that the diff made wrong.
  • Skip node_modules, _generated, lockfiles, build output, and assets unless they are hand written.
  • Keep each description under one line. What it is for, not how it works.
Show full SKILL.md (254 more words)Show less

Convex projects

When the repo has a convex/ folder, the changelog and files.md can name Convex features, but only ones the source proves. references/convex-detection.md lists what file shows what.

Short version:

  • A component counts only if convex/convex.config.ts registers it. A dependency in package.json is not proof.
  • Crons count only if convex/crons.ts exists and registers a job.
  • HTTP actions count only if convex/http.ts has a route.
  • Auth counts only if convex/auth.config.ts or an auth component is present.
  • AI model names count only if code or config names them. Do not guess which model built the app.

Prefer none over an invented value.

Redaction

changelog.md and files.md are often public. Treat them that way.

  • Never open .env, .env.local, or any secret store to fill in a doc. Env var names are fine to mention. Values never.
  • Never include API keys, tokens, email addresses, phone numbers, street addresses, private hostnames, or application data records.
  • Scan the whole file before saving, not just the new lines. Replace any address shaped text with [redacted] and say so in one line.
  • Log behavior, not identifiers. "Signed webhook verification for inbound mail" is fine. The inbox address is not.

Boundaries

  • Edit only task.md, changelog.md, files.md, and PRDs the user points at. Nothing else unless asked.
  • Never commit, push, deploy, publish, or tag. Print the suggested commit message instead.
  • Never rewrite older entries for tone. Fix facts when the evidence contradicts them and flag the correction.
  • Do not call production APIs or query live data to make the docs richer.

Report format

Synced project docs.

changelog.md  added 2.1.0 (2026-09-15): 3 added, 1 fixed
files.md      added 2 files, updated 1 description
task.md       moved 1 item to Completed, 1 still In Progress (verification pending: e2e)

Suggested commit: docs: sync changelog, files, and tasks for 2.1.0

© waynesutton, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 5 other files (references, assets) in skills/project-docs of waynesutton/builder-skills.

  • SKILL.md
  • agents/openai.yaml
  • assets/large-logo.png
  • assets/small-logo.svg
  • references/convex-detection.md
  • references/evidence-rules.md

Open the folder on GitHubat commit 82d1ce2

Compare with similar skills

Project Docs next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Project Docs compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Project Docs this skillwaynesutton/builder-skills404—~1.3kAutomated safety check: NotesApache-2.0
Release Bumpjamiepine/voicebox57k—~1.1kAutomated safety check: PassMIT
Git Workflow and Versioningaddyosmani/agent-skills103k2 repos~3.5kAutomated safety check: NotesMIT
Go-Redis Release Preparationredis/go-redis22k—~1.1kAutomated safety check: PassBSD-2-Clause
pybind11 Release Preparationpybind/pybind1118k—~1.7kAutomated safety check: PassCustom licence
AionUi Version BumpiOfficeAI/AionUi33k—~2.1kAutomated safety check: PassApache-2.0

Similar skills

  • Release Bump

    jamiepine/voicebox

    Ends a release cycle by moving the Unreleased changelog notes under a dated version heading, bumping version files with bumpversion and tagging the commit.

    57k GitHub stars~1.1k tokensUpdated yesterday
    DevelopmentAuto-check passed
  • Git Workflow and Versioning

    addyosmani/agent-skills

    Sets git habits for every change: short-lived branches, atomic commits with descriptive messages, clean pull requests, plus versioning, tagging and changelogs for releases.

    103k GitHub starsUsed in 2 repos~3.5k tokens
    DevelopmentAuto-check: notes
  • Official

    Prepares a go-redis release locally: picks the next semver, gathers merged PRs, writes the RELEASE-NOTES entry and bumps versions, without publishing.

    22k GitHub stars~1.1k tokensUpdated today
    DevelopmentAuto-check passed
  • Opens the pybind11 release-preparation pull request: picking the release base, bumping the version in common.h and integrating the changelog, following docs/release.rst.

    18k GitHub stars~1.7k tokensUpdated today
    DevelopmentAuto-check passed
  • AionUi Version Bump

    iOfficeAI/AionUi

    Automates an AionUi release: checks the latest AionCore release and its artifacts, updates package.json, writes the changelog, opens a PR and tags the release.

    33k GitHub stars~2.1k tokensUpdated 29 days ago
    DevelopmentAuto-check passed
  • Hunk Release Workflow

    modem-dev/hunk

    Maintainer workflow for preparing, publishing, verifying and curating Hunk releases, with confirmation gates before tags, publishes and public edits.

    9.5k GitHub stars~3.8k tokensUpdated today
    DevelopmentAuto-check passed

More from waynesutton/builder-skills

All 17 skills in this repo
  • Convex Agents

    waynesutton/builder-skills

    Builds AI agents on the Convex agent component: threads, messages, tools that call queries and mutations, streaming, RAG with vector search, and workflows for multi step jobs.

    404 GitHub stars~2.2k tokensUpdated 10 days ago
    Auto-check passed
  • Convex Best Practices

    waynesutton/builder-skills

    Production patterns for Convex apps and the rules the @convex-dev/eslint-plugin enforces: validators, indexes, idempotent mutations, avoiding OCC conflicts, thin function wrappers, error handling.

    404 GitHub stars~2.6k tokensUpdated 10 days ago
    Auto-check passed
  • Convex Component Authoring

    waynesutton/builder-skills

    Creates reusable Convex components with defineComponent, a clean client wrapper, their own schema, and an npm publish setup.

    404 GitHub stars~2.6k tokensUpdated 10 days ago
    Auto-check passed
  • Convex Cron Jobs

    waynesutton/builder-skills

    Schedules work in Convex: cron jobs in convex/crons.ts, one off scheduled functions with runAfter and runAt, batching large jobs, and cancelling or inspecting the queue.

    404 GitHub stars~2k tokensUpdated 10 days ago
    Auto-check passed
  • Convex HTTP Actions

    waynesutton/builder-skills

    Adds HTTP endpoints in convex/http.ts: webhook receivers with signature checks, REST style routes, CORS, auth headers, streaming responses, and file uploads over HTTP.

    404 GitHub stars~2.6k tokensUpdated 10 days ago
    Auto-check passed
  • Convex Migrations

    waynesutton/builder-skills

    Changes a live Convex schema without downtime: make a field optional, backfill in batches, flip the validator, then clean up.

    404 GitHub stars~2.1k tokensUpdated 10 days ago
    Auto-check passed

Works with

Categories

Questions about Project Docs

What does Project Docs do?

Brings task.md, changelog.md, and files.md back in sync with what the code says shipped. Project Docs is an agent skill from waynesutton/builder-skills.md back in sync with what the code says shipped.

When should I use Project Docs?

Project Docs fits situations like: the user says update the docs; update files.md; task.md and the code disagree.

How do I install Project Docs in Claude Code?

Run `npx skills add waynesutton/builder-skills --skill project-docs -a claude-code`. Or copy the skill folder (skills/project-docs in waynesutton/builder-skills) into .claude/skills/project-docs in your project. Claude Code loads it when a task matches its description.

How do I install Project Docs in Codex?

Run `npx skills add waynesutton/builder-skills --skill project-docs -a codex`. Or copy the skill folder (skills/project-docs in waynesutton/builder-skills) into .agents/skills/project-docs in your project. Codex loads it when a task matches its description.

Can I use Project Docs in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add waynesutton/builder-skills --skill project-docs -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/project-docs, .gemini/skills/project-docs, .github/skills/project-docs and .opencode/skills/project-docs in your project.

What does Project Docs need to run?

Going by SKILL.md and its folder, Project Docs needs the command-line tools its instructions call (git).

Does Project Docs access the network?

SKILL.md contains no URLs. Its commands use git, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Project Docs safe to install?

Our automated static check of SKILL.md found notes only (mentions a .env file), nothing it rates as a warning. It is not a guarantee. Review the folder before installing.

What licence does Project Docs use?

Project Docs is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Project Docs use?

About 1.3k tokens (SKILL.md is roughly 5.4k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 1.5k tokens, read only when the agent opens those files.

What are the alternatives to Project Docs?

Skills that share tags, products or a category with Project Docs: Release Bump (jamiepine/voicebox, 57k stars), Git Workflow and Versioning (addyosmani/agent-skills, 103k stars), Go-Redis Release Preparation (redis/go-redis, 22k stars) and pybind11 Release Preparation (pybind/pybind11, 18k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Project Docs?

waynesutton (a GitHub user) maintains it in waynesutton/builder-skills, which has 404 GitHub stars. The repository holds 17 skills in this directory. The repository was last updated on September 28, 2026.

Source: waynesutton/builder-skills on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.