Agent Md Refactor

davila7/claude-code-templates/cli-tool/components/skills/development/agent-md-refactor

作者 davila78da17d671b6fMIT32K 个星标收录于 2026年10月8日更新于 2026年10月8日仓库今天更新

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

来源与署名

来源:davila7/claude-code-templates位于cli-tool/components/skills/development/agent-md-refactor提交8da17d6

许可证: MIT

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架