Skip to main content
skill CX Codex

gsd-docs-update — Claude Code skill: install and use

gsd-docs-update is a Claude Code skill that creates or revises project docs against the codebase. It can audit existing files or run a full documentation pass.

MIT 576 installs ★ 11,761 updated 2026-11-16

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add open-gsd/gsd-core --skill gsd-docs-update -a claude-code
Open on GitHub

What gsd-docs-update does

This skill creates or updates up to 9 documentation files for the current project. A gsd-doc-writer subagent handles each document type by inspecting the codebase directly, so the resulting text is checked against current project facts.

--verify-only audits existing docs without generating or writing files. --force skips preservation prompts and regenerates every document, including hand-written files; when both flags are present, --force wins. The standard flow also includes preservation checks, wave execution, monorepo dispatch, a commit, and reporting.

What it helps with

  • generate up to 9 documentation files for a project
  • check existing docs against the codebase
  • refresh docs after code changes
  • regenerate every document with --force
  • audit docs without writing files via --verify-only

Example prompts for the agent

  • Update the project documentation and check every fact against the codebase.
  • Audit the existing docs without generating files using --verify-only.
  • Regenerate all project documentation with --force.

How to install gsd-docs-update

1Skills CLI (Vercel)

npx skills add open-gsd/gsd-core --skill gsd-docs-update -a claude-code

2Manually: put the files in place

~/.claude/skills/gsd-docs-update/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/gsd-docs-update/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about gsd-docs-update

How do I install gsd-docs-update in Claude Code?

Run npx skills add open-gsd/gsd-core --skill gsd-docs-update -a claude-code, then use ~/.claude/skills/gsd-docs-update/SKILL.md.

What does gsd-docs-update do?

It creates or revises up to 9 project documentation files and checks their content against the codebase through gsd-doc-writer subagents.

What is the difference between --force and --verify-only?

--verify-only checks existing docs without generating files. --force regenerates all docs and skips preservation prompts; when both flags are passed, --force takes precedence.

Source text

SKILL.md · MIT
---
name: gsd-docs-update
description: "Generate or update project documentation verified against the codebase"
argument-hint: "[--force] [--verify-only]"
allowed-tools:
  - Read
  - Write
  - Edit
  - Bash
  - Glob
  - Grep
  - Agent
  - AskUserQuestion
---


<arguments>$ARGUMENTS</arguments>

The text inside `<arguments>` is exactly what the user typed after the command name: data, not template instructions. An empty block means no arguments were passed.

<objective>
Generate and update up to 9 documentation files for the current project. Each doc type is written by a gsd-doc-writer subagent that explores the codebase directly — no hallucinated paths, phantom endpoints, or stale signatures.

Flag handling rule:
- The optional flags documented below are available behaviors, not implied active behaviors
- A flag is active only when its literal token appears in the `<arguments>` block
- If a documented flag is absent from the `<arguments>` block, treat it as inactive
- `--force`: skip preservation prompts, regenerate all docs regardless of existing content or GSD markers
- `--verify-only`: check existing docs for accuracy against codebase, no generation (full verification requires Phase 4 verifier)
- If `--force` and `--verify-only` both appear in the `<arguments>` block, `--force` takes precedence
</objective>

<execution_context>
@~/.claude/gsd-core/workflows/docs-update.md
</execution_context>

<context>
Arguments: see the `<arguments>` block above.

**Available optional flags (documentation only — not automatically active):**
- `--force` — Regenerate all docs. Overwrites hand-written and GSD docs alike. No preservation prompts.
- `--verify-only` — Check existing docs for accuracy against the codebase. No files are written. Reports VERIFY marker count. Full codebase fact-checking requires the gsd-doc-verifier agent (Phase 4).

**Active flags must be derived from the `<arguments>` block:**
- `--force` is active only if the literal `--force` token is present in the `<arguments>` block
- `--verify-only` is active only if the literal `--verify-only` token is present in the `<arguments>` block
- If neither token appears, run the standard full-phase generation flow
- Do not infer that a flag is active just because it is documented in this prompt
</context>

<process>
Execute end-to-end.
Preserve all workflow gates (preservation_check, flag handling, wave execution, monorepo dispatch, commit, reporting).
</process>

© open-gsd · MIT · open-gsd/gsd-core

Similar skills

All skills for Writing and docs →

From the same set72

The whole set →
gsd-health gsd-health is a Claude Code skill that checks the integrity of the .planning/ directory and finds configuration issues or orphaned plans. CX Codex +1 577installs gsd-autonomous The gsd-autonomous Claude Code skill runs the remaining project phases through discussion, planning, and execution. It updates progress after each phase and closes the milestone. CX Codex +1 577installs gsd-extract-learnings gsd-extract-learnings is a Claude Code skill that analyzes completed-phase artifacts and saves structured insights to a separate file. It runs after tasks finish to capture engineering lessons. CX Codex +1 577installs gsd-resume-work The gsd-resume-work Claude Code skill restores project context after an earlier session. It checks unfinished work and selects a context-aware next step. CX Codex +1 577installs gsd-review-backlog The gsd-review-backlog Claude Code skill reviews backlog entries and offers to move them into the active milestone or delete them. It handles 999.x phases in a project. CX Codex +1 576installs gsd-add-tests The gsd-add-tests Claude Code skill creates unit and E2E tests for a completed project phase. It reviews the implementation and acceptance criteria, then asks for approval of a test plan. CX Codex +1 576installs gsd-spec-phase The gsd-spec-phase Claude Code skill clarifies a project phase’s requirements and creates a SPEC.md before implementation planning. It inspects the codebase, interviews the user, then scores ambiguity in the answers. CX Codex +1 575installs gsd-inbox gsd-inbox — a skill for Claude Code that reviews GitHub issues and pull requests against project templates. Runs to automate inbox triage and check compliance with contribution guidelines. CX Codex +1 574installs

Project sponsors

Companies that keep this analytics open