feat(knowledge): 统一维护项目文档落盘配置
This commit is contained in:
zhiye.sun
@@ -26,7 +26,7 @@ description: 初始化或更新项目的 AGENTS.md 与 .craftkit 项目资料；
|
||||
5. 展示拟创建或修改的文件及关键内容，取得确认后再写入。
|
||||
6. 从 [assets](assets/project.json) 中选择模板，生成或合并 `AGENTS.md`、`.craftkit/project.json`、目录说明、嵌套忽略规则和必要索引；存在前端能力时同时准备 `.craftkit/standards/frontend/components.md` 的最小索引。
|
||||
7. 已有文件必须先完整读取并做保守合并；不明确的用户章节和字段原样保留，不直接覆盖。
|
||||
8. 初始化后验证 JSON、索引链接，以及 `.craftkit/local/`、`.craftkit/cache/` 的 Git 忽略状态。
|
||||
8. 初始化后验证 JSON、索引链接，以及 `.craftkit/local/`、`.craftkit/cache/` 的 Git 忽略状态；按[文档目录配置](references/project-config.md#文档目录)验证过程、共享设计和归档路径的用途及解析结果，不创建示例文档。
|
||||
9. 使用 `guidance` 对一个真实项目问题执行检索验证；未安装该 Skill 时改用相同的入口顺序手工验证。
|
||||
|
||||
框架版本写入 `technology.frameworks`。成熟项目优先从构建清单和锁文件探测；空项目根据用户选择或参考项目建议填写。只有公共 profile 已真实存在且版本范围匹配时才写入 `profile`，否则保留为空并记录待确认事项。
|
||||
@@ -35,6 +35,8 @@ description: 初始化或更新项目的 AGENTS.md 与 .craftkit 项目资料；
|
||||
|
||||
## 安全边界
|
||||
|
||||
初始化或更新 `documents` 时，区分过程文档、共享交付文档与归档目标。读取已有值和明确的文档规范；缺失字段按[文档目录配置](references/project-config.md#文档目录)提出默认值，纳入第 5 步的统一预览。目录只按需创建，不因根目录已有说明文档就把根目录配置为过程文档目录。
|
||||
|
||||
- 不读取或保存密码、令牌、私钥、完整数据库连接串和私有仓库认证信息。
|
||||
- 扫描配置文件时只提取框架、数据库类型、依赖标识等非秘密元数据；疑似凭据只报告位置和风险。
|
||||
- 参考项目只用于用户指定的结构、依赖、命名、测试、规范或工具范围，不复制业务代码和专属规则正文。
|
||||
|
||||
@@ -16,6 +16,7 @@
|
||||
- Agent 补充说明：`.craftkit/agents/index.md`
|
||||
- 项目规范：`.craftkit/standards/index.md`
|
||||
- 可复用知识：`.craftkit/knowledge/index.md`
|
||||
- 共享设计文档：`.craftkit/designs/`；开发中过程文档使用 `.craftkit/project.json` 配置的 `documents.workRoot`。
|
||||
|
||||
## 工作约束
|
||||
|
||||
|
||||
@@ -7,8 +7,9 @@
|
||||
- `standards/`：项目自身的开发、测试、文档与 Git 规范。
|
||||
- `standards/frontend/components.md`：经确认的前端组件来源、版本和契约证据索引。
|
||||
- `knowledge/`：经过验证的技术决策和可复用经验。
|
||||
- `designs/`：用户明确要求共享或正式交付的设计文档。
|
||||
- `handoff/`：用户明确选择共享的任务交接。
|
||||
- `local/`：当前工作副本的本地上下文，不进入 Git。
|
||||
- `local/`：当前工作副本的过程文档和本地上下文，不进入 Git。
|
||||
- `cache/`：可重新生成的缓存，不进入 Git。
|
||||
|
||||
共享资料不得包含凭据、个人机器绝对路径或无必要的业务数据。
|
||||
|
||||
@@ -12,7 +12,12 @@
|
||||
"documentation": []
|
||||
},
|
||||
"commands": { "build": [], "test": [], "check": [] },
|
||||
"documents": { "archiveRoot": "docs/archive", "archiveRules": [] },
|
||||
"documents": {
|
||||
"workRoot": ".craftkit/local/tasks",
|
||||
"designRoot": ".craftkit/designs",
|
||||
"archiveRoot": "docs/archive",
|
||||
"archiveRules": []
|
||||
},
|
||||
"guidance": {
|
||||
"agentIndex": ".craftkit/agents/index.md",
|
||||
"standardsIndex": ".craftkit/standards/index.md",
|
||||
|
||||
@@ -11,10 +11,26 @@
|
||||
- `dependencies.internal` 只记录用户确认可在当前仓库共享的依赖标识和用途。
|
||||
- `frontend` 记录前端框架、组件库、组件根和文档入口；路径必须是项目相对路径，版本必须有依赖清单、锁文件或用户确认作为证据。
|
||||
- `commands` 只记录经过项目文件或用户确认的命令。
|
||||
- `documents.archiveRoot` 记录可共享的文档归档根；`documents.archiveRules` 记录项目确认的匹配、目标模板、转换和校验规则，不写入公司固定目录或外部系统凭据。
|
||||
- `documents` 区分过程文档、共享设计和归档目录，字段及回退行为见下方“文档目录”；归档规则不写入公司固定目录或外部系统凭据。
|
||||
- `guidance` 指向 `.craftkit/` 内的索引入口。
|
||||
- `initialization.references` 记录参考项目名称、用途、允许提炼范围和可共享的相对位置。
|
||||
|
||||
## 文档目录
|
||||
|
||||
| 字段 | 默认值 | 用途 |
|
||||
| --- | --- | --- |
|
||||
| `workRoot` | `.craftkit/local/tasks` | 开发中的需求、计划、设计草稿和验证记录，默认不提交 |
|
||||
| `designRoot` | `.craftkit/designs` | 用户明确要求共享或正式交付的设计文档 |
|
||||
| `archiveRoot` | `docs/archive` | 用户按归档规则处理的历史或正式归档文档 |
|
||||
| `archiveRules` | `[]` | 归档匹配、目标、转换和校验规则 |
|
||||
|
||||
- 路径使用项目相对路径和正斜杠，不能包含 `..`、用户目录或其他个人机器绝对路径。
|
||||
- 初始化只写入配置，不预建空任务目录、设计目录或归档目录。
|
||||
- 成熟项目已有明确的过程文档或正式设计目录时优先延续，并展示证据；根目录中的 README、CHANGELOG 或总体工作流不能单独证明根目录是任务文档目录。
|
||||
- 用户未指定共享用途时，Skill 生成的过程文档使用 `workRoot`；用户明确要求共享或正式交付时使用 `designRoot`。
|
||||
- `archiveRoot` 不作为开发中内容的默认写入位置，归档必须按归档 Skill 的规则另行执行。
|
||||
- 旧配置只有 `archiveRoot` 时继续兼容读取；初始化更新时展示新增字段及用途，确认后保守合并。
|
||||
|
||||
## 前端组件信息
|
||||
|
||||
- `frontend.framework` 引用 `technology.frameworks` 中已确认的前端框架名称。
|
||||
|
||||
Reference in New Issue
Block a user