Agent Md Refactor

softaworks/agent-toolkit/skills/agent-md-refactor

作者 softaworks3027f20f3181758385a1bb8c022d4041dfb4de84MIT2.5K 個星標收錄於 2026年10月9日更新於 2026年10月9日儲存庫7 個月前更新

Refactor bloated AGENTS.md, CLAUDE.md, or similar agent instruction files to follow progressive disclosure principles. Splits monolithic files into organized, linked documentation.

僅含說明AI & Agents
AI 產生的概覽

將臃腫的代理指令檔重構為精簡根檔案加上分類連結文件。

功能
此技能引導對 AGENTS.md、CLAUDE.md 或 COPILOT.md 等代理指令檔進行五階段重構。它會找出互相矛盾的指令,只擷取適用於所有任務的重點放入根檔案,把其餘指令歸入依主題劃分的檔案,並產出根檔案與連結文件。它也會標記冗餘、含糊或過時的指令以供刪除,並提供驗證檢查。
適用情境
當代理指令檔過長或過於單一時,可用它重新組織。它適合拆分、整理 AGENTS.md、CLAUDE.md 或類似設定檔,或對其套用漸進式揭露的請求。
執行需求
不需要指令碼或工具,僅為指令型技能。它處理使用者現有的代理指令檔,可能需要使用者解決其中的矛盾。

Agent MD Refactor

Refactor bloated agent instruction files (AGENTS.md, CLAUDE.md, COPILOT.md, etc.) to follow progressive disclosure principles - keeping essentials at root and organizing the rest into linked, categorized files.


Triggers

Use this skill when:

  • "refactor my AGENTS.md" / "refactor my CLAUDE.md"
  • "split my agent instructions"
  • "organize my CLAUDE.md file"
  • "my AGENTS.md is too long"
  • "progressive disclosure for my instructions"
  • "clean up my agent config"

Quick Reference

PhaseActionOutput
1. AnalyzeFind contradictionsList of conflicts to resolve
2. ExtractIdentify essentialsCore instructions for root file
3. CategorizeGroup remaining instructionsLogical categories
4. StructureCreate file hierarchyRoot + linked files
5. PruneFlag for deletionRedundant/vague instructions

Process

Phase 1: Find Contradictions

Identify any instructions that conflict with each other.

Look for:

  • Contradictory style guidelines (e.g., "use semicolons" vs "no semicolons")
  • Conflicting workflow instructions
  • Incompatible tool preferences
  • Mutually exclusive patterns

For each contradiction found:

markdown
## Contradiction Found
**Instruction A:** [quote]**Instruction B:** [quote]
**Question:** Which should take precedence, or should both be conditional?

Ask the user to resolve before proceeding.


Phase 2: Identify the Essentials

Extract ONLY what belongs in the root agent file. The root should be minimal - information that applies to every single task.

Essential content (keep in root):

CategoryExample
Project descriptionOne sentence: "A React dashboard for analytics"
Package managerOnly if not npm (e.g., "Uses pnpm")
Non-standard commandsCustom build/test/typecheck commands
Critical overridesThings that MUST override defaults
Universal rulesApplies to 100% of tasks

NOT essential (move to linked files):

  • Language-specific conventions
  • Testing guidelines
  • Code style details
  • Framework patterns
  • Documentation standards
  • Git workflow details

Phase 3: Group the Rest

Organize remaining instructions into logical categories.

Common categories:

CategoryContents
typescript.mdTS conventions, type patterns, strict mode rules
testing.mdTest frameworks, coverage, mocking patterns
code-style.mdFormatting, naming, comments, structure
git-workflow.mdCommits, branches, PRs, reviews
architecture.mdPatterns, folder structure, dependencies
api-design.mdREST/GraphQL conventions, error handling
security.mdAuth patterns, input validation, secrets
performance.mdOptimization rules, caching, lazy loading

Grouping rules:

  1. Each file should be self-contained for its topic
  2. Aim for 3-8 files (not too granular, not too broad)
  3. Name files clearly: {topic}.md
  4. Include only actionable instructions

Phase 4: Create the File Structure

Output structure:

project-root/├── CLAUDE.md (or AGENTS.md)     # Minimal root with links└── .claude/                      # Or docs/agent-instructions/    ├── typescript.md    ├── testing.md    ├── code-style.md    ├── git-workflow.md    └── architecture.md

Root file template:

markdown
# Project Name
One-sentence description of the project.
## Quick Reference
- **Package Manager:** pnpm- **Build:** `pnpm build`- **Test:** `pnpm test`- **Typecheck:** `pnpm typecheck`
## Detailed Instructions
For specific guidelines, see:- [TypeScript Conventions](.claude/typescript.md)- [Testing Guidelines](.claude/testing.md)- [Code Style](.claude/code-style.md)- [Git Workflow](.claude/git-workflow.md)- [Architecture Patterns](.claude/architecture.md)

Each linked file template:

markdown
# {Topic} Guidelines
## OverviewBrief context for when these guidelines apply.
## Rules
### Rule Category 1- Specific, actionable instruction- Another specific instruction
### Rule Category 2- Specific, actionable instruction
## Examples
### Good\`\`\`typescript// Example of correct pattern\`\`\`
### Avoid\`\`\`typescript// Example of what not to do\`\`\`

Phase 5: Flag for Deletion

Identify instructions that should be removed entirely.

Delete if:

CriterionExampleWhy Delete
Redundant"Use TypeScript" (in a .ts project)Agent already knows
Too vague"Write clean code"Not actionable
Overly obvious"Don't introduce bugs"Wastes context
Default behavior"Use descriptive variable names"Standard practice
OutdatedReferences deprecated APIsNo longer applies

Output format:

markdown
## Flagged for Deletion
| Instruction | Reason ||-------------|--------|| "Write clean, maintainable code" | Too vague to be actionable || "Use TypeScript" | Redundant - project is already TS || "Don't commit secrets" | Agent already knows this || "Follow best practices" | Meaningless without specifics |

Execution Checklist

[ ] Phase 1: All contradictions identified and resolved[ ] Phase 2: Root file contains ONLY essentials[ ] Phase 3: All remaining instructions categorized[ ] Phase 4: File structure created with proper links[ ] Phase 5: Redundant/vague instructions removed[ ] Verify: Each linked file is self-contained[ ] Verify: Root file is under 50 lines[ ] Verify: All links work correctly

Anti-Patterns

AvoidWhyInstead
Keeping everything in rootBloated, hard to maintainSplit into linked files
Too many categoriesFragmentationConsolidate related topics
Vague instructionsWastes tokens, no valueBe specific or delete
Duplicating defaultsAgent already knowsOnly override when needed
Deep nestingHard to navigateFlat structure with links

Examples

Before (Bloated Root)

markdown
# CLAUDE.md
This is a React project.
## Code Style- Use 2 spaces- Use semicolons- Prefer const over let- Use arrow functions... (200 more lines)
## Testing- Use Jest- Coverage > 80%... (100 more lines)
## TypeScript- Enable strict mode... (150 more lines)

After (Progressive Disclosure)

markdown
# CLAUDE.md
React dashboard for real-time analytics visualization.
## Commands- `pnpm dev` - Start development server- `pnpm test` - Run tests with coverage- `pnpm build` - Production build
## Guidelines- [Code Style](.claude/code-style.md)- [Testing](.claude/testing.md)- [TypeScript](.claude/typescript.md)

Verification

After refactoring, verify:

  1. Root file is minimal - Under 50 lines, only universal info
  2. Links work - All referenced files exist
  3. No contradictions - Instructions are consistent
  4. Actionable content - Every instruction is specific
  5. Complete coverage - No instructions were lost (unless flagged for deletion)
  6. Self-contained files - Each linked file stands alone

來源與署名

來源:softaworks/agent-toolkit位於skills/agent-md-refactor提交3027f20

授權條款: MIT

內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。

檢舉或申請下架