igugyj/project-ai-docs

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. 事实可验 — 只写实测路径/版本/命令，不写猜测 内容 安装（DSH） A：复制到技能发现根（零依赖，免构建） 层级 路径 用户级（推荐） %USERPROFILE%\.dsh\skills\ 全局 agents-home %USERPROFILE%\.agents\skills\ 项目级 \.dsh\skills\ 或 \.agents\skills\ B：dsh plugin 安装（随 profile 管理） B 路利用包内 dsh.bundle.patch → cordis.patch.yml → extensions/dsh/index.js ，把 skills/ 树注册为 DSH 技能源（同 Aegis 做法）。装完重启 DSH 生效。 其他宿主（Claude Code / Codex 等）：复制 skills/project-ai-docs/ 到各自 skills 路径即可。 使用 触发 行为 新会话开始 读 index + changelog，点读相关分层文档 「初始化项目文档」/「/init」 Init 协议：扫描项目 → 建骨架 → 实测填充 任务完成后 清冗余 → 回写对应文档 → changelog 记账 给新项目的 Init 速查 发布（手动） 仓库已带 GitHub Action（ .github/workflows/publish.yml ），手动触发，发布 package.json 当前版本： 1. 生成 npm Granular Access Token（GAT） （CI 用，免 OTP；npm 正限制 bypass-2FA token 直发，GAT 是官方推荐）： - 网页：npmjs.com → Access Tokens → Generate New Token → Granular Access Token - 选 Publish package…

分类