Update project docs

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

607 stars

Best use case

Update project docs is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

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

Teams using Update project docs should expect a more consistent output, faster repeated execution, less prompt rewriting.

When to use this skill

  • You want a reusable workflow that can be run more than once with consistent structure.

When not to use this skill

  • You only need a quick one-off answer and do not need a reusable workflow.
  • You cannot install or maintain the underlying files, dependencies, or repository context.

Installation

Claude Code / Cursor / Codex

$curl -o ~/.claude/skills/update-project-docs/SKILL.md --create-dirs "https://raw.githubusercontent.com/waynesutton/markdown-site/main/.cursor/skills/update-project-docs/SKILL.md"

Manual Installation

  1. Download SKILL.md from GitHub
  2. Place it in .claude/skills/update-project-docs/SKILL.md inside your project
  3. Restart your AI agent — it will auto-discover the skill

How Update project docs Compares

Feature / AgentUpdate project docsStandard Approach
Platform SupportNot specifiedLimited / Varies
Context Awareness High Baseline
Installation ComplexityUnknownN/A

Frequently Asked Questions

What does this skill do?

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

Where can I find the source code?

You can find the source code on GitHub using the link provided at the top of the page.

SKILL.md Source

# 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:

```bash
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:

```markdown
- [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`:

```markdown
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:

```markdown
## [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.

Related Skills

robel-auth

607
from waynesutton/markdown-site

Integrate and maintain Robelest Convex Auth in apps by always checking upstream before implementation. Use when adding auth setup, updating auth wiring, migrating between upstream patterns, or troubleshooting @robelest/convex-auth behavior across projects.

Create a PRD

607
from waynesutton/markdown-site

Use this skill before any multi-file feature, architectural decision, or complex bug fix.

convex-self-hosting

607
from waynesutton/markdown-site

Integrate Convex static self hosting into existing apps using the latest upstream instructions from get-convex/self-hosting every time. Use when setting up upload APIs, HTTP routes, deployment scripts, migration from external hosting, or troubleshooting static deploy issues across React, Vite, Next.js, and other frontends.

convex-return-validators

607
from waynesutton/markdown-site

Guide for when to use and when not to use return validators in Convex functions. Use this skill whenever the user is writing Convex queries, mutations, or actions and needs guidance on return value validation. Also trigger when the user asks about Convex type safety, runtime validation, AI-generated Convex code, Convex AI rules, Convex security best practices, or when they're debugging return type issues in Convex functions. Trigger this skill when users mention "validators", "returns", "return type", or "exact types" in the context of Convex development. Also trigger when writing or reviewing Convex AI rules or prompts that instruct LLMs how to write Convex code.

convex-doctor

607
from waynesutton/markdown-site

Run convex-doctor static analysis, interpret findings, and fix issues across security, performance, correctness, schema, and architecture categories. Use when running convex-doctor, fixing convex-doctor warnings or errors, improving the convex-doctor score, or when asked about Convex code quality, static analysis, or linting Convex functions.

write

607
from waynesutton/markdown-site

Writing style guide for technical content, social media, blog posts, READMEs, git commits, and developer documentation. Optimized to avoid AI detection patterns. Use when writing any content beyond code.

workflow

607
from waynesutton/markdown-site

Project workflow for PRDs, task tracking, changelog sync, and documentation updates. Use for any non-trivial task that spans multiple steps, touches several files, changes architecture, or needs project tracking updates. Also activates with @update to sync task.md, changelog.md, and files.md after completing work.

sec-check

607
from waynesutton/markdown-site

Security review checklist for Convex functions, auth logic, public queries, admin routes, webhooks, uploads, and AI-generated code. Use when reviewing code that touches user data, PII, or access control.

schema-builder

607
from waynesutton/markdown-site

Design and generate Convex database schemas with proper validation, indexes, and relationships. Use when creating schema.ts or modifying table definitions.

real-time-backend

607
from waynesutton/markdown-site

Build reactive, type-safe, production-grade backends. ALWAYS use this skill when the user asks to build, plan, design, or implement backend features, APIs, data models, server logic, database schemas, web apps, full stack apps, or mobile apps. This includes planning and architecture discussions.

react-effect-decision

607
from waynesutton/markdown-site

Combine React's official "You Might Not Need an Effect" guidance with this project's stricter no direct useEffect stance. Use when writing, reviewing, or refactoring React components that might reach for useEffect, derived state, event relays, reset logic, subscriptions, or client fetching.

migration-helper

607
from waynesutton/markdown-site

Plan and execute Convex schema migrations safely, including adding fields, creating tables, and data transformations. Use when schema changes affect existing data.