# aicoding

**Repository Path**: cuone/aicoding

## Basic Information

- **Project Name**: aicoding
- **Description**: 常用 AI 编程开发规则，文档编写规范
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 12
- **Forks**: 3
- **Created**: 2025-06-19
- **Last Updated**: 2026-09-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: cursor, rules

## README

# aicoding

`aicoding` 是一套可复用的 AI coding 规则与 workflows，用于在业务项目中提供统一的 `AGENTS.md`、rules、skills 以及配套说明文档。

当前仓库可视为一个初始版本；后续会根据实际使用情况持续调整和完善说明、规则与 workflows。

## 设计来源

本仓库直接拷贝并沿用开源仓库 `mattpocock/skills` 的 skill 体系与目录结构，当前基于 `skills-1.2.3` 版本整理。

当前仓库的主要调整包括：

- 保留原有 skills、rules、workflows 的组织方式与执行入口。
- 将 `docs/` 中面向人的说明文档翻译并维护为中文。
- 在不改变 workflow 设计逻辑的前提下，补充当前仓库自身的入口说明与使用说明。

沿用的核心结构包括：

- 以 `AGENTS.md` 作为项目入口。
- 以 `.agents/rules/` 保存项目规则。
- 以 `.agents/skills/` 保存可复用 workflows。
- 每个 skill 以 `SKILL.md` 作为执行入口。
- 以 `docs/` 保存面向项目成员的 skill 说明。
- 以 bucket 分类组织 skills：`engineering`、`productivity`、`in-progress`、`misc`。

其中，`SKILL.md` 与 workflow 设计逻辑保持原版开源 skills 的定义；`docs/` 为当前仓库维护的中文翻译说明。命令、路径、skill 名、API 名以及成熟工程术语保留英文。

## 快速使用

将以下内容复制到业务项目根目录：

```text
AGENTS.md
.agents/
README_AI_CODING.md
```

复制后，各部分职责如下：

- `AGENTS.md`：AI 执行入口。
- `.agents/rules/`：项目规则。
- `.agents/skills/`：workflows。
- `README_AI_CODING.md`：AI coding 使用说明。

## 首次初始化

首次在业务项目中使用 engineering workflows 前，先执行：

```text
.agents/skills/engineering/setup-matt-pocock-skills/SKILL.md
```

该 workflow 用于配置 tracker、triage labels 以及 docs 位置。tracker 也可以使用本地文件方式。

## 文档分工

- `AGENTS.md`：说明规则与 skills 的读取入口。
- `.agents/rules/*.md`：定义长期生效的项目规则。
- `.agents/skills/**/SKILL.md`：定义具体 workflow，是实际执行的真源。
- `README_AI_CODING.md`：提供整体使用说明和完整 skill 清单。
- `docs/`：提供各 skill 的中文说明，便于理解用途、适用场景和流程位置。

如果文档说明与 `SKILL.md` 不一致，以对应 `SKILL.md` 为准。

## Skill 分类

- `engineering/`：工程开发 workflows，包括设计、实现、测试、排查、评审、规格说明和任务拆分。
- `productivity/`：协作与表达 workflows，包括访谈、交接、教学、提问和写作辅助。
- `in-progress/`：试验性 workflows，后续可能继续变化，使用前先阅读对应 `SKILL.md`。
- `misc/`：低频辅助 workflows，按明确需求使用。

## 维护约定

- 新增、删除或重命名 skill 后，同步检查 `README_AI_CODING.md` 和 `docs/`。
- 修改 workflow 行为时，以对应 `SKILL.md` 为准，并同步更新面向人的说明文档。
- 不在 README 中复制完整 workflow；完整执行流程只写在对应 `SKILL.md`。
- 不自动提交、推送、合并或发布，除非用户明确要求。