Which files does this skill use as a source of truth?

The skill primarily reads package.json for script definitions and .env.example for environment variable configurations.

Does it support comments in package.json?

Yes, it specifically attempts to include descriptions from comments associated with scripts in your package.json file.

Can I see changes before they are applied?

Yes, the skill provides a diff summary to show exactly what was modified or generated during the sync process.

What documents does it automatically generate?

It generates or updates docs/CONTRIB.md (for contributor workflows) and docs/RUNBOOK.md (for deployment and operations).

How does it identify obsolete documentation?

It scans your documentation directory for files that have not been modified in 90 days or more and flags them for manual review.

Documentation Synchronizer

Name: Documentation Synchronizer
Author: sc30gsw

bysc30gsw

•

学习与文档

Synchronizes project documentation by extracting real-time data from source-of-truth files like package.json and environment templates.

This skill automates the maintenance of essential project documentation by treating your configuration files as the single source of truth. It parses package.json and .env.example to automatically generate and update contributor guides (CONTRIB.md) and operational runbooks (RUNBOOK.md). By extracting script descriptions and environment variable requirements directly from the source, it ensures that onboarding and deployment instructions never drift from the actual codebase. Additionally, it helps maintain high documentation standards by identifying stale files that haven't been updated in over 90 days.

主要功能

01Automates the creation of CONTRIB.md and RUNBOOK.md

02Provides a detailed diff summary of all generated changes

03Extracts and documents environment variables from .env.example

048 GitHub stars

05Generates scripts reference tables directly from package.json

06Identifies obsolete documentation files for manual review

使用场景

01Auditing large documentation repositories to prune outdated content

02Maintaining production runbooks with up-to-date deployment and rollback procedures

03Onboarding new developers with accurate development and testing workflows

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add sc30gsw/claude-code-customes update-docs

For use in Claude.ai and ChatGPT

Download Skill