skills.rest
linzhifen5
linzhifen5COMMUNITY
Explore all skills by this author →
GitHub

a-org-rules

Synchronize CLAUDE.md and README.md rule files with actual project structure and add code comments.

Updated Aug 27, 2026
Search Tags:#typescript#documentation#readme#code comments#claude.md#sync#electron
One-click install
npx skills add https://github.com/linzhifen5/claude-skill-org-rules --skill a-org-rules-linzhifen5
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: a-org-rules
Source: https://github.com/linzhifen5/claude-skill-org-rules
Command: npx skills add https://github.com/linzhifen5/claude-skill-org-rules --skill a-org-rules-linzhifen5

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Project documentation like CLAUDE.md and README.md quickly drifts out of sync with the actual codebase as dependencies, directory structures, and commands change, forcing developers to manually reconcile docs with reality. ## Core Features & Use Cases - Rule File Synchronization: Scans package.json, directory trees, and entry files to update tech stack versions, command lists, and directory structures in CLAUDE.md and README.md. - Automatic Code Commenting: Adds file-header and JSDoc comments to .ts, .tsx, and .css files in src/ and electron/ directories, and converts existing English comments to Chinese. - Maintenance Logging & Git Push: Records each organization run in memory/rule-file-maintenance.md and pushes skill updates to GitHub automatically. - Use Case: After adding a new app module and upgrading dependencies, run the skill to regenerate the directory structure section, refresh version badges, and annotate newly created source files in one pass. ## Quick Start Ask the AI to organize the project's CLAUDE.md and README.md files and add comments to the src directory files.

Frequently Asked Questions about a-org-rules

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

FAQPage Schema
How do I keep CLAUDE.md and README.md in sync with my project?▼

Run the skill to scan your package.json, directory tree, and entry files, then automatically update tech stack versions, command lists, and directory structures in both files. It ensures the two documents stay identical in structure.

How to automatically add comments to TypeScript files?▼

The skill scans .ts, .tsx, and .css files in src/ and electron/ directories, adds a file-header comment describing the file's purpose, and adds JSDoc comments to exported functions. Files that already have comments are skipped.

Does it work with Electron and React projects?▼

Yes, it covers src/ and electron/ directories and includes guidance for Electron frameless windows on macOS, such as configuring WebkitAppRegion drag areas in React components alongside BrowserWindow settings.

Will it overwrite my existing code comments?▼

No, files that already contain comments are skipped to avoid duplication. When existing English comments are found, they are converted to concise Chinese while preserving the comment syntax.

What are the limitations of automatic documentation sync?▼

It only records main dependencies rather than exhaustive lists and takes a conservative approach, leaving content unchanged when uncertain. It focuses on CLAUDE.md, README.md, and .gitignore rather than arbitrary documentation files.

Related Skills

Explore More Software Engineering Skills→
cacackcacack
4

audit-docs

Detect documentation drift between project docs and repository code.

Community
Intermediate
MiDouTechMiDouTech

release-version

Automate semantic versioning and release execution for git-based projects.

Official
Advanced
dotBeepsdotBeeps

typescript-check

Run tsc and ESLint to detect, interpret, and prioritize TypeScript errors.

Community
Intermediate
ainexllcainexllc

docs-generator

Generate JSDoc/TSDoc comments, API references, and READMEs from TypeScript and JavaScript source code.

Community
Intermediate