project-ai-docs
v0.1.1 · 1 天前发布
通用项目 AI 文档协议 skill:每项目一份 docs/.ai 认知库,防上下文涣散、保项目认知精细。(DSH plugin)
README
project-ai-docs
通用项目 AI 文档协议 skill:每项目一份 docs/.ai/ 认知库,agent 会话先读索引再动手、改动必回写,防上下文涣散、保项目认知精细。
英文版见 README.en.md。
通用法则
1. 地图先行 — index.md 唯一入口,全文档优先级路由表
2. 分层预算 — core/modules/config/best-practices 四层,显式优先级管 token 开销
3. 红线前置 — 硬约束(禁止项)放 index 最顶,先于一切技术信息
4. 点读代替全读 — 模块化文档,按任务只读相关切片
5. 写回闭环 — 任务结束 = 文档更新,知识沉淀在文档不靠会话记忆
6. 增量感知 — changelog 台账,新会话读尾部即知项目现状
7. 人机分离 — README 给用户,docs/.ai 给 agent
8. 事实可验 — 只写实测路径/版本/命令,不写猜测
内容
```
project-ai-docs/
├── skills/project-ai-docs/ # 运行时技能单元(DSH 插件式安装的发现根)
│ ├── SKILL.md # 协议本体(中文)
│ ├── SKILL.en.md # 协议英文版(替换式:改名覆盖 SKILL.md 即用)
│ ├── template/ # Init 骨架·中文(复制即用)
│ └── template.en/ # Init 骨架·英文
├── extensions/dsh/index.js # DSH bundle
版本兼容矩阵
| DSH 版本 | 状态 | 说明 |
|---|---|---|
dsh@0.1.0-rc.6 | ✅ 兼容 | cordis patch ✅ |
dsh@0.1.0 | ✅ 兼容 | 标准 patch ✅ |
dsh@0.2.0 | ⚠️ 待验证 | 待实测(API 可能在变) |
dsh@0.3.0+ | ❓ 未知 | 尚未发布 |
💡 兼容矩阵每周末自动跑实测,欢迎 PR 修正
元数据
- License
- MIT
- npm
- project-ai-docs
- Repo
- —
- Engines
{}- Weekly DL
- 0
- Monthly DL
- 0
- dsh.bundle
{"bundle":{"patch":"./cordis.patch.yml"}}