166 lines
3.3 KiB
Markdown
166 lines
3.3 KiB
Markdown
# 结构化项目开发技能
|
|
|
|
`AI编程助手` `项目管理` `工作流` `Claude Code` `文档驱动`
|
|
|
|
# mbank
|
|
|
|
适用于 Claude Code、Codex 和 Cursor 的结构化项目开发技能。
|
|
|
|
`mbank` 帮助 AI 智能体从模糊的产品想法出发，通过分层项目文档（而非即兴聊天记忆）进入有纪律的实现工作流。
|
|
|
|
## 为什么用 mbank
|
|
|
|
大多数智能体工作流擅长写代码，但在以下方面较弱：
|
|
- 将模糊想法转化为可用的设计简报
|
|
- 在长对话中保持项目上下文
|
|
- 同步维护架构、进度和实现文档
|
|
|
|
`mbank` 通过文档优先的工作流解决这些问题：
|
|
|
|
```text
|
|
/discover -> /mbank -> /scaffold -> build -> /check -> /archive
|
|
```
|
|
|
|
## 功能说明
|
|
|
|
- `/discover`
|
|
将模糊想法扩展并细化，生成 `mbank/discovery.md` 和 `mbank/design.md`
|
|
- `/mbank`
|
|
将 `mbank/design.md` 转化为清晰计划，并生成 `mbank/tech-stack.md`
|
|
- `/scaffold`
|
|
生成项目运作文档，包括 `AGENTS.md`、`implementation-plan.md`、`progress.md`、`architecture.md` 和 `quickref.md`
|
|
- `/check`
|
|
执行显式验证和文档一致性检查
|
|
- `/archive`
|
|
快照一个里程碑，并重置当前进度追踪
|
|
|
|
## 安装
|
|
|
|
```bash
|
|
# Claude Code
|
|
git clone https://github.com/Aitcmb/mbank.git ~/.claude/skills/mbank
|
|
|
|
# Codex / OpenAI Agents
|
|
git clone https://github.com/Aitcmb/mbank.git ~/.codex/skills/mbank
|
|
|
|
# Cursor
|
|
git clone https://github.com/Aitcmb/mbank.git ~/.cursor/skills/mbank
|
|
```
|
|
|
|
## 快速开始
|
|
|
|
### 1. 创建项目文件夹
|
|
|
|
```bash
|
|
mkdir mbank
|
|
```
|
|
|
|
### 2. 从探索阶段开始
|
|
|
|
如果项目想法仍然模糊：
|
|
|
|
```text
|
|
/discover
|
|
```
|
|
|
|
此阶段生成：
|
|
- `mbank/discovery.md`
|
|
- `mbank/design.md`
|
|
|
|
### 3. 确认技术方向
|
|
|
|
```text
|
|
/mbank
|
|
```
|
|
|
|
此阶段将：
|
|
- 读取 `mbank/design.md`
|
|
- 补全缺失的约束条件
|
|
- 评估复杂度
|
|
- 生成 `mbank/tech-stack.md`
|
|
|
|
### 4. 生成工作脚手架
|
|
|
|
```text
|
|
/scaffold
|
|
```
|
|
|
|
此阶段生成：
|
|
- `AGENTS.md`
|
|
- `CLAUDE.md`（可选兼容文件）
|
|
- `mbank/implementation-plan.md`
|
|
- `mbank/progress.md`
|
|
- `mbank/architecture.md`
|
|
- `mbank/quickref.md`
|
|
- `mbank/context/`
|
|
|
|
### 5. 开发、验证、归档
|
|
|
|
```text
|
|
/check
|
|
/archive
|
|
```
|
|
|
|
## 核心文件
|
|
|
|
```text
|
|
your-project/
|
|
├── AGENTS.md
|
|
├── CLAUDE.md
|
|
├── .claude/
|
|
│ └── rules/
|
|
└── mbank/
|
|
├── discovery.md
|
|
├── design.md
|
|
├── tech-stack.md
|
|
├── quickref.md
|
|
├── architecture.md
|
|
├── implementation-plan.md
|
|
├── progress.md
|
|
├── context/
|
|
└── archive/
|
|
```
|
|
|
|
## 上下文模型
|
|
|
|
`mbank` 使用分层上下文，而非一次性加载所有内容：
|
|
|
|
- `AGENTS.md`
|
|
项目主规则文件
|
|
- `.claude/rules/`
|
|
全局硬性约束
|
|
- `mbank/quickref.md`
|
|
始终读取的快速参考
|
|
- `mbank/architecture.md`
|
|
架构与职责说明
|
|
- `mbank/design.md`
|
|
正式产品/设计定义
|
|
- `mbank/discovery.md`
|
|
早期阶段推理与范围权衡
|
|
- `mbank/progress.md`
|
|
当前进度与活跃状态
|
|
- `mbank/context/`
|
|
仅在需要时加载的模块级深度上下文
|
|
|
|
## 仓库结构
|
|
|
|
- `SKILL.md`
|
|
主技能说明文件
|
|
- `defaults.md`
|
|
示例偏好配置文件
|
|
- `references/`
|
|
仅按需加载的模板文件
|
|
- `CHANGELOG.md`
|
|
版本历史记录
|
|
|
|
## 模板
|
|
|
|
仓库在 `references/` 目录中包含可复用模板：
|
|
|
|
- `discovery-template.md`
|
|
- `design-template.md`
|
|
- `scaffold-templates.md`
|
|
|
|
## 许可证
|
|
|
|
MIT |