Can I customize the files it generates?

The skill follows a standardized pattern for CONTRIB.md and RUNBOOK.md to ensure consistency, pulling data directly from your project's configuration.

How does update-docs identify environment variables?

The skill reads the .env.example file, extracts all keys, and documents their purpose and format based on the source file structure.

Where does the skill get the descriptions for scripts?

It extracts descriptions directly from comments located within the scripts section of your package.json file.

What are the primary sources of truth for this skill?

The skill treats package.json and .env.example as the authoritative sources for project configuration, scripts, and environment setups.

Does it automatically delete old files?

No, it identifies files not modified in over 90 days and lists them for manual review to prevent accidental data loss while helping you identify tech debt.

Documentation Sync

Name: Documentation Sync
Author: Eotel

byEotel

0•

コンテンツ管理

Synchronizes project documentation automatically using source-of-truth files like package.json and environment configurations.

The update-docs skill automates the tedious task of keeping technical documentation in sync with codebase changes. By treating package.json and .env.example as the primary sources of truth, it generates comprehensive script references, environment variable guides, and standardized project files such as CONTRIB.md and RUNBOOK.md. This ensures that onboarding materials and operational procedures remain accurate, while also highlighting obsolete documentation that may require manual review, significantly reducing the maintenance overhead for developers.

主な機能

010 GitHub stars

02Automatically generates script reference tables from package.json files

03Generates standardized CONTRIB.md and RUNBOOK.md documentation files

04Identifies obsolete documentation files not modified in 90+ days

05Provides a detailed diff summary of all documentation changes for review

06Extracts and documents environment variables directly from .env.example

ユースケース

01Automating documentation updates during the release cycle to ensure accuracy

02Auditing large codebases to find and prune stale or outdated documentation

03Standardizing contributor guides and runbooks across multiple repositories

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add eotel/claude-marketplace update-docs

For use in Claude.ai and ChatGPT

Download Skill