agent-md-refactor

Name: agent-md-refactor
Availability: InStock
Author: Santychuy

Refactor monolithic agent instruction files into linked markdown hierarchies.

Updated Jan 17, 2024

Search Tags:#documentation #markdown #agent #organization #refactor #progressive disclosure

Ready to run

npx skills add https://github.com/santychuycom/santychuy.com --skill agent-md-refactor-santychuycom

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: agent-md-refactor
Source: https://github.com/santychuycom/santychuy.com/tree/main/.agents/skills/agent-md-refactor
Command: npx skills add https://github.com/santychuycom/santychuy.com --skill agent-md-refactor-santychuycom

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill tackles the issue of overly long and complex agent instruction files (like AGENTS.md or CLAUDE.md) by restructuring them for better readability and maintainability.

Core Features & Use Cases

Progressive Disclosure: Organizes information by separating essential, universally applicable instructions from detailed, topic-specific guidelines.
File Splitting: Transforms monolithic files into a clean root file with links to categorized sub-files (e.g., for TypeScript, testing, code style).
Use Case: Refactor a 500-line CLAUDE.md file into a concise root file with links to separate, well-organized markdown files for code style, testing, and Git workflow.

Quick Start

Use the agent-md-refactor skill to split my AGENTS.md file into organized, linked documentation.

Frequently Asked Questions about agent-md-refactor

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

FAQPage Schema

How do I restructure bloated agent instruction files?▼

Restructure bloated agent instruction files by refactoring monolithic configurations into a structured hierarchy using progressive disclosure. This splits essential root instructions from detailed topic-specific guidelines into linked markdown files for better maintainability.

What is progressive disclosure for agent documentation?▼

Progressive disclosure for agent documentation is an organizing principle that separates universally applicable instructions from topic-specific guidelines. It structures information so essential rules remain in a root file while detailed guidelines link out to categorized sub-files.

How do I split a large CLAUDE.md or AGENTS.md file?▼

Split a large CLAUDE.md or AGENTS.md file by transforming the monolithic document into a concise root file with links to categorized sub-files. This separates code style, testing, and Git workflow guidelines into distinct linked markdown files.

What's the best way to organize agent configuration markdown?▼

The best way to organize agent configuration markdown is applying progressive disclosure principles to separate essential instructions from detailed topic-specific guidelines. This approach addresses poor maintainability and information overload by creating linked, categorized markdown files.

When should I refactor my agent instructions?▼

Refactor your agent instructions when documentation becomes overly long and complex, causing information overload and poor maintainability. A 500-line monolithic configuration file is a strong indicator that splitting into a structured hierarchy is necessary.