update-docs

Generate docs/CONTRIB.md and docs/RUNBOOK.md from package.json scripts and .env.example.

Updated Jan 16, 2026
One-click install
npx skills add https://github.com/Eotel/claude-marketplace --skill update-docs-eotel
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/Eotel/claude-marketplace/tree/main/plugins/base/skills/update-docs
Command: npx skills add https://github.com/Eotel/claude-marketplace --skill update-docs-eotel

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Syncs project documentation from source-of-truth files, ensuring documentation stays current with code and environment configuration.

Core Features & Use Cases

  • Automatic documentation generation: Reads package.json scripts and .env.example to build up-to-date docs/CONTRIB.md and docs/RUNBOOK.md.
  • Audit and cleanup: Identifies obsolete docs not touched in 90+ days for manual review.
  • Single source of truth: Uses package.json and .env.example as authoritative references.

Quick Start

Run the update-docs script to synchronize docs with the source-of-truth files.

Frequently Asked Questions about update-docs

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

FAQPage Schema
How do I automatically sync documentation with package.json scripts and .env.example?

You can automatically sync documentation by reading package.json scripts and .env.example as source-of-truth files to generate up-to-date docs/CONTRIB.md and docs/RUNBOOK.md, ensuring a single source of truth across development and deployment contexts.

What is the best way to identify obsolete documentation in a monorepo?

The best way to identify obsolete documentation is to audit docs that have not been touched in 90 or more days, flagging them for manual review against the authoritative package.json and .env.example references.

How does generating docs from .env.example and package.json scripts work?

Generating docs from .env.example and package.json works by extracting environment variables and script definitions from those authoritative files, then building unified documentation sets that reflect the current codebase configuration.

Can I use this docs-sync approach for monorepos with multiple package.json files?

Yes, this docs-sync approach applies to monorepos containing package.json scripts and an .env.example, reading those source-of-truth files across development and deployment contexts to maintain synchronized project documentation.

Why does my project documentation keep getting out of sync with environment variables?

Project documentation gets out of sync when environment variables and scripts change in package.json or .env.example without corresponding manual updates to docs, which automation solves by using those files as a single source of truth.

Do I need any external dependencies to automate documentation generation from package.json?

No external dependencies are required to automate documentation generation from package.json and .env.example, as the process reads those existing source-of-truth files directly to build the unified docs set.