AGENT SKILL

agents-md-refactor

重构已有 AGENTS.md 与相关文档,使其符合渐进披露原则、仓库事实和中文输出要求。适用于用户要求优化、精简、拆分、合并或重写现有 agent 指南时。默认保留真实有效的信息,移除模板化、过时或无证据内容,并确保根 AGENTS.md 简洁可导航。

License 许可
MIT
最近更新
2026-10-04
Stars
★ 39
Forks
4

01 前言 Front Matter

name
agents-md-refactor
description
重构已有 AGENTS.md 与相关文档,使其符合渐进披露原则、仓库事实和中文输出要求。适用于用户要求优化、精简、拆分、合并或重写现有 agent 指南时。默认保留真实有效的信息,移除模板化、过时或无证据内容,并确保根 AGENTS.md 简洁可导航。

03 SKILL.md 正文

重构 AGENTS.md

将现有 AGENTS.md 按渐进披露原则重构为精简根文件 + 独立详情文件。

执行步骤

1. 查找矛盾

读取现有 AGENTS.md 以及它指向的相关文档,识别彼此冲突的指令。对每一处矛盾,先询问用户希望保留哪个版本,再继续。

2. 识别核心内容

只保留应放在根目录 AGENTS.md 中的内容:

  • 一句话项目描述
  • 包管理器(如果不是 npm)
  • 非标准的构建/类型检查命令
  • 真正与每一项任务都相关的全局约定

3. 标记可删除内容

识别并建议删除以下类型的指令:

  • 冗余:agent 已知的通用知识(如"编写干净的代码")
  • 模糊:无法执行或缺少上下文
  • 过时:与仓库实际代码不符

逐一列出,等待用户确认后再删除。

4. 分组其余内容

将剩余指令按逻辑类别组织(如 TypeScript 约定、测试模式、API 设计、Git 工作流),为每个分组创建独立 Markdown 文件。

5. 创建文件结构

输出以下文件:

AGENTS.md              # 极简根文件,含指向各详情文件的链接
docs/
├── backend.md         # 后端架构与约定
├── frontend.md        # 前端架构与约定
└── ...                # 按实际分组决定

根 AGENTS.md 模板:

# AGENTS.md

[一句话项目描述]

## 关键约定
- 包管理器:[uv/npm/...]
- [其他全局约定]

## 详细文档
- [后端架构与约定](docs/backend.md)
- [前端架构与约定](docs/frontend.md)

输出语言

所有生成内容使用中文。

04 同仓库更多 Skills