43 lines
1.9 KiB
Markdown
43 lines
1.9 KiB
Markdown
# CraftKit
|
|
|
|
CraftKit 是面向 Codex 的通用插件工具集，覆盖软件开发、文档处理、Git 交付、项目知识维护和 Skill 管理。每个插件均可独立安装，能力描述保持简洁、中性，并以当前 Codex 能力和公开标准为基础维护。
|
|
|
|
## 插件组成
|
|
|
|
| 插件 | 用途 |
|
|
| --- | --- |
|
|
| `dev` | 软件需求分析、设计、实现、审查、测试、升级与估算 |
|
|
| `doc` | 文档转换、整理、归档与写作 |
|
|
| `git` | 分支、提交、变更提取、集成与发布准备 |
|
|
| `knowledge` | 项目初始化、任务交接、问题复盘与经验维护 |
|
|
| `skill` | 项目规范检索、维护与 Skill 辅助工具 |
|
|
|
|
## 目录结构
|
|
|
|
```text
|
|
CraftKit/
|
|
├─ .agents/plugins/marketplace.json # 仓库级 Codex 插件市场清单
|
|
├─ AGENTS.md # 项目协作与维护约定
|
|
├─ plugins/ # 可独立安装的插件
|
|
│ ├─ dev/
|
|
│ ├─ doc/
|
|
│ ├─ git/
|
|
│ ├─ knowledge/
|
|
│ └─ skill/
|
|
└─ README.md
|
|
```
|
|
|
|
## 设计原则
|
|
|
|
- 每个 Skill 聚焦一个清晰能力，名称与触发描述准确，避免宽泛兜底或重复功能。
|
|
- 优先读取当前项目的代码、配置、规范和用户输入，不把特定组织、产品或环境假设写入通用能力。
|
|
- 公共技术规则基于适用版本的官方资料维护；项目专属规则保存在项目自己的 `.craftkit/standards/` 中。
|
|
- 涉及写文件、Git 状态、外部系统或发布的操作必须明确边界，并按风险取得用户授权。
|
|
- 静态检查、脚本测试和真实场景验证分别记录，不用其中一种替代另一种。
|
|
|
|
## 本地使用
|
|
|
|
本仓库提供仓库级 marketplace。将仓库注册为本地 marketplace 后，可按需安装 `dev`、`doc`、`git`、`knowledge` 或 `skill` 插件。
|
|
|
|
正式公开发布前，还需补充许可证、公开仓库地址、作者信息、隐私政策和市场素材。
|