update-docs

Generate Markdown documentation from package.json and .env.example files.

Updated Feb 10, 2026
One-click install
npx skills add https://github.com/ihj04982/my-cursor-settings --skill update-docs-ihj04982
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/ihj04982/my-cursor-settings/tree/main/skills/update-docs
Command: npx skills add https://github.com/ihj04982/my-cursor-settings --skill update-docs-ihj04982

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the process of keeping documentation up-to-date by syncing information from primary sources like package.json and .env.example.

Core Features & Use Cases

  • Automated Documentation Generation: Creates and updates key documentation files like CONTRIB.md and RUNBOOK.md.
  • Source-of-Truth Synchronization: Ensures documentation accurately reflects the current state of the project's scripts and environment variables.
  • Use Case: After updating project dependencies or adding new scripts, run this Skill to automatically regenerate the developer contribution guide and operational runbook.

Quick Start

Run the update-docs skill to sync documentation from source-of-truth.

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 from package.json and .env.example files?

You can automate documentation sync by parsing package.json and .env.example files to extract project scripts and environment variables, then generating updated Markdown files like contribution guides and runbooks.

What is the best way to generate a developer runbook from project scripts?

Generating a developer runbook is best done by extracting script definitions and environment configurations from source-of-truth files, then automatically producing Markdown documentation that reflects the current project state.

How do I keep contribution guides updated when dependencies or scripts change?

To keep contribution guides updated, run an automated documentation synchronization process that parses the latest package.json and .env.example files to regenerate Markdown guides reflecting current dependencies and scripts.

Can I parse JSON and environment variable files to produce Markdown documentation?

Yes, you can parse JSON and environment variable files to produce Markdown documentation by extracting configuration data and script information, then formatting it into structured contribution guides and operational runbooks.

What limitations exist when automating documentation generation from source-of-truth files?

Automating documentation generation from source-of-truth files is limited to parsing JSON and environment variable formats, meaning documentation accuracy depends entirely on the structure and content of package.json and .env.example files.