update-docs

Extract documentation from package.json and .env.example into CONTRIB.md and RUNBOOK.md.

11|2|Updated Aug 1, 2025
One-click install
npx skills add https://github.com/sc30gsw/claude-code-customes --skill update-docs-sc30gsw
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/sc30gsw/claude-code-customes/tree/main/.claude/skills/update-docs
Command: npx skills add https://github.com/sc30gsw/claude-code-customes --skill update-docs-sc30gsw

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Syncs and consolidates documentation by deriving it from authoritative source-of-truth files like package.json and .env.example, reducing drift and manual effort.

Core Features & Use Cases

  • Reads the scripts section of package.json to generate a clear scripts reference table and captures meaningful descriptions from inline comments.
  • Scans .env.example to extract environment variables, their purposes, and formats for documentation.
  • Generates docs/CONTRIB.md with development workflow, docs/RUNBOOK.md with deployment procedures and run guidelines, and surfaces obsolete docs for review.
  • Produces a diff summary to highlight changes and track documentation evolution.

Quick Start

Use the update-docs skill to synchronize documentation from source-of-truth files and regenerate the docs.

Frequently Asked Questions about update-docs

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

FAQPage Schema
How do I generate documentation from package.json and .env.example files?

To generate documentation from package.json and .env.example files, this Skill reads the scripts section and environment variables to automatically produce consistent docs, reducing manual effort and configuration drift.

What's the best way to automate syncing project docs with source files?

Automating project docs syncing is best handled by extracting definitions directly from source-of-truth files like package.json, which ensures your documentation evolves consistently with your development workflows without manual updates.

Can I automatically generate a development workflow and deployment runbook?

Yes, you can generate a development workflow and deployment runbook automatically. This Skill creates docs/CONTRIB.md for development procedures and docs/RUNBOOK.md for deployment guidelines directly from your source files.

How do I track obsolete documentation in an automated docs workflow?

Tracking obsolete documentation in an automated workflow involves surfacing outdated docs for review. This Skill identifies obsolete files during extraction and produces a diff summary to highlight changes and track documentation evolution.

Do I need any external dependencies to extract environment variables for docs?

No external dependencies are needed to extract environment variables for docs. This Skill operates independently to scan .env.example files and capture variable purposes and formats without requiring additional packages.

Does syncing documentation from source-of-truth files work for large projects?

Syncing documentation from source-of-truth files works for large projects by consolidating scripts and environment variables into centralized references, reducing drift and manual effort across complex development workflows.