Skip to content
Skills Library
Programming · Automation

project-docs

/project-docs

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.

Licence
Apache-2.0
Last repository change
27.09.2026

Assessment and security

100/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content35 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
6
Scripts
0
HTML comments
0
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 27.09.2026, without references to retired models or APIs.

Licence

Apache-2.0, otwarta: można używać i zmieniać, z zachowaniem licencji i informacji o zmianach.

What it does and when to use it

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.

Triggers from the description

update the docssync changelogupdate files.md@update
Original author 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.

How it works

  1. Run the sync
  2. task.md
  3. changelog.md
  4. files.md
  5. Convex projects
  6. Redaction
  7. Boundaries
  8. Report format
Original SKILL.md headings · 102 lines, 825 words
SKILL.md preview
---
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.

| File | Answers |
| --- | --- |
| `task.md` | What is planned, in flight, and done |
| `changelog.md` | What changed for users, by version and date |
| `files.md` | What 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](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.

## 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](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
```
Files in this package (6)
  • SKILL.md 5 KB
  • agents/openai.yaml 1 KB
  • assets/large-logo.png 3 KB
  • assets/small-logo.svg 1 KB
  • references/convex-detection.md 4 KB
  • references/evidence-rules.md 2 KB

Versions

RepositoryScoreLicence
This page · waynesutton/builder-skills100Apache-2.0
coco-research/coco100MIT
nasrulhazim/claude100MIT
event4u-app/agent-config100MIT
GGaryyy/POBG100MIT
DPatta/project-docs-kit100MIT
DPatta/project-docs-kit100MIT
jezweb/claude-skills100MIT
xstongxue/best-skills100Apache-2.0

Identical content appears in 1 other GitHub folders. We show one copy with the highest score.

Database snapshot: 13.11.2026 · package version 3410ef3dd02f (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 100update-project-docs
    Brings task.md, changelog.md, and files.md back in sync with what the code says shipped, then prints a commit message as plain text. 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…
  • 100update-changelog
    Creates or updates CHANGELOG.md following the Keep a Changelog 1.1.0 format. Use this skill when the user asks to "update the changelog", "generate changelog", "add changelog entry", "create CHANGELOG.md", "sync changelog with tags", or wants to document project changes based on…
  • 100update-changelog
    Update docs/CHANGELOG.md from git history, GitHub releases, and code diffs. Use when: writing release notes, syncing the latest changelog entry, summarizing a new tag, or keeping changelog wording concise and consistent.
  • 90changelog-writer
    Read the git log and write a user-facing changelog entry in Keep a Changelog format. Use when the user wants to document what changed in a release, write release notes, or update their CHANGELOG.md.
  • 100dockeeper
    Use when synchronizing docs/ and README with the current implementation state. Triggers: user says "docs を同期", "ドキュメント更新", "仕様書更新", "README 更新", "sync docs", or /docs-sync command is invoked. Provides: git log analysis, task-based diff detection, docs/spec/ + README.md / README.ja.md update.
  • 100changelog
    Generate or update CHANGELOG.md files by reading git history. Use this skill whenever the user wants to document what changed in their project — whether they say "create a changelog", "update the changelog", "write release notes", "what's new since v1.2", "document changes for…

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.