Update Project Docs

Update Project Docs

Orchestrate the upgrade of a project's documentation structure when the project-docs scaffold template has released structural changes.

When to Use

Activate when:

• User mentions upgrading their docs structure
• User says they downloaded a new version of the scaffold template
• User asks to migrate or update their documentation layout
• A version mismatch is detected between the project and the template

How Versioning Works

The docs structure version is tracked in docs/​README.md frontmatter:

---
docs_version: "2.0.0" # x-release-please-version
docs_template: https://github.com/ichabodcole/project-docs-scaffold-template
---

This version is kept in sync with the scaffold template's package version by release-please. The x-release-please-version annotation tells release-please to update this line automatically when a new version is released.

How to read the version:

• No docs_version frontmatter → pre-2.0 (original flat structure)
• docs_version: "X.Y.Z" → matches the scaffold template release version

What triggers a version bump (with a migration guide):

• New documentation category added (e.g., backlog/, memories/)
• Structural reorganization (e.g., flat dirs → project folders)
• Template content changes that affect how documents are created
• README convention changes that affect document lifecycle

Not every version bump requires a migration. Minor and patch releases that don't change structure won't have a migration file — only major structural changes do.

What does NOT trigger a version bump:

• Prose fixes in READMEs
• Minor template wording adjustments
• Plugin-only changes (commands, skills, agents)

Upgrade Process

Step 1: Detect Current Version

Check the project's docs/​README.md for the version marker:

grep "docs_version" docs/​README.md

If no version marker exists, the project is on v1 (the original flat structure with proposals/, plans/, sessions/).

Step 2: Identify Target Version

Check the latest version available. The target is typically the version in the scaffold template you're upgrading to. Migration files in this skill document each version transition.

Step 3: Find Applicable Migrations

Look in this skill's migrations/ folder for each version step between current and target. Migrations must be applied in sequence — you can't skip versions.

Example: upgrading from v1 to v2.1 requires:

1. migrations/​v1-to-v2.md
2. migrations/​v2.0-to-v2.1.md (if it exists)

Step 4: Execute Each Migration

For each migration file:

1. Read the migration guide
2. Follow its steps in order — most migrations have a companion script in migrations/​scripts/ that handles mechanical steps. Run --dry-run first to preview, then run without the flag. Only content-editing steps (flowchart updates, README prose) remain for the agent.
3. Verify the checklist at the end
4. Move to the next migration

Step 5: Update Version Marker

After all migrations are applied, update the version comment in docs/​README.md to reflect the new version.

Step 6: Ensure Root-Level Agent Context

Check whether the project's root-level CLAUDE.md or AGENTS.md references the docs structure. Agents read these files first when entering a project — if there's no pointer to docs/, agents have to discover the documentation on their own.

grep -l "docs/​README\|docs/​memories\|documentation.*docs/" CLAUDE.md AGENTS.md 2>/​dev/​null

If neither file references the docs structure, recommend adding a section like this to whichever file the project uses for agent context:

## Documentation

This project uses structured documentation in `docs/`. See
[docs/​README.md](./docs/README.md) for the full structure overview and document
type guide.

For quick onboarding on recent work, start with
[docs/​memories/](./docs/memories/).

This is a recommendation, not a required step — the user may prefer to word it differently or place it in a different file. Present the blurb and ask where they'd like it.

Step 7: Verify

Run a final check that no stale references to old structure remain:

# Check for references specific to the migration
# (each migration file lists what to grep for)

Available Migrations

Creating New Migration Guides

When the scaffold template releases structural changes:

1. Create a new migration file: migrations/​vX-to-vY.md
2. Use the migration-authoring skill to ensure every step is agent-executable
3. Run the quality checklist before finalizing
4. Update the table above
5. The version in docs/​README.md is bumped automatically by release-please

Migration file structure:

# Migration: vX → vY

## Summary

[What changed and why]

## What's New

[New directories, files, or conventions]

## What Moved

[Files or directories that changed location]

## What's Removed

[Directories or files no longer used]

## Step-by-Step Migration

[Ordered steps to perform the upgrade]

## Cross-Reference Updates

[Paths that change and need updating]

## Verification

[How to confirm the migration succeeded]

## Checklist

[Checkbox list of all migration actions]