gsd-docs-update

Generate and verify project documentation directly against the codebase.

Updated Aug 15, 2025
One-click install
npx skills add https://github.com/gesmith0606/nfl_data_engineering --skill gsd-docs-update-gesmith0606
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: gsd-docs-update
Source: https://github.com/gesmith0606/nfl_data_engineering/tree/main/.claude/skills/gsd-docs-update
Command: npx skills add https://github.com/gesmith0606/nfl_data_engineering --skill gsd-docs-update-gesmith0606

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation often drifts from the codebase, making onboarding and maintenance harder. This Skill generates or updates project documentation directly from the current codebase to ensure accuracy, consistency, and alignment with the code.

Core Features & Use Cases

  • Generates up to 9 docs using the gsd-doc-writer workflow, aligned with code markers and project structure.
  • Verifies existing docs against the codebase and gracefully handles edits, with --force to regenerate and --verify-only to validate without changes.
  • Supports an end-to-end workflow from discovery to publication, enabling teams to keep living documentation in sync with code.

Quick Start

Run the docs-update workflow to refresh the project's documentation set from the latest codebase.

Frequently Asked Questions about gsd-docs-update

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically generate and verify project documentation from my codebase?

To generate and verify project documentation, this Skill automates documentation creation directly against the codebase. It uses the gsd-doc-writer workflow to produce up to nine aligned docs while enforcing a frontmatter-driven workflow for accuracy.

How do I verify existing project docs against the source code without making changes?

To verify existing project docs without applying changes, you can use the --verify-only flag. This validates that your current documentation matches the codebase and gracefully flags any drift without regenerating the files.

What is the best way to regenerate outdated documentation across multiple software modules?

The best way to regenerate outdated documentation across multiple modules is by using the --force flag. This overrides preservation prompts and triggers the gsd-doc-writer to rebuild up to nine project docs from the latest code structure.

Can I integrate documentation generation into an automated software engineering workflow?

Yes, you can integrate documentation generation into an automated software engineering workflow for onboarding and compliance. The Skill supports an end-to-end workflow from code discovery to publication, keeping living documentation continuously in sync.

Why does documentation drift from the codebase and how can I prevent it during maintenance?

Documentation drifts from the codebase during maintenance when updates are manual, but you prevent it by running automated verification directly against the source code. This ensures ongoing accuracy, consistency, and alignment for compliance.

Does the documentation update workflow support projects with multiple modules and frontmatter?

Yes, the documentation update workflow explicitly supports software projects with multiple modules. It enforces a frontmatter-driven workflow, respects preservation prompts, and integrates with a gsd-doc-writer subagent to manage the doc set.