update-docs

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

Updated Jun 25, 2026
One-click install
npx skills add https://github.com/YuriNakayama/neurogolf --skill update-docs-yurinakayama
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/YuriNakayama/neurogolf/tree/main/.claude/skills/update-docs
Command: npx skills add https://github.com/YuriNakayama/neurogolf --skill update-docs-yurinakayama

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill automates the synchronization and updates of documentation, reducing manual work and ensuring the accuracy of user-facing resources.

Core Features & Use Cases

  • Documentation Synchronization: Syncs documentation from the source of truth to the local repository.
  • Automatic Script Generation: Reads package.json and .env.example to create documentation on scripts, environment variables, and setup instructions.
  • Documentation Management: Generates and manages documentation like RUNBOOK.md for deployment and monitoring, and CONTRIB.md for development guidelines.

Quick Start

Run 'update-docs sync' to update your documentation based on source files.

Frequently Asked Questions about update-docs

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

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

Documentation synchronization automates updates by reading package.json and .env.example as source-of-truth files to generate accurate setup instructions and environment variable references. Running the sync command updates local repository documentation automatically.

What is the best way to generate a RUNBOOK.md for deployment and monitoring instructions?

Generating a RUNBOOK.md is automated by reading your project's source-of-truth files and producing deployment and monitoring documentation. This ensures operational runbooks stay synchronized with your package.json configuration without manual writing.

Can I automatically generate documentation for environment variables defined in .env.example?

Yes, environment variable documentation is generated automatically by parsing .env.example files. The synchronization process reads these source-of-truth files and creates accurate references for all defined variables in your local repository.

How do I keep development guidelines in CONTRIB.md updated with my project configuration?

Development guidelines in CONTRIB.md are kept updated through automated documentation synchronization. The tool reads your package.json and generates contribution documentation that reflects current scripts and setup instructions without manual maintenance.

Does documentation synchronization work without additional dependencies or plugins?

Yes, documentation synchronization works without additional dependencies or plugins. The tool operates independently using built-in scripts to read source-of-truth files and generate documentation, requiring no external packages to function.

When do I need to run documentation synchronization in a software development workflow?

Documentation synchronization should be run whenever package.json or .env.example files change. This ensures generated documentation like RUNBOOK.md and CONTRIB.md stays accurate and reflects the current source-of-truth configuration.