feat(skill): 新增项目规范维护 Skill
This commit is contained in:
@@ -0,0 +1,17 @@
|
||||
# 接入新规范
|
||||
|
||||
## 输入判断
|
||||
|
||||
- 用户提供文件时,先确认其授权范围、是否保留原文以及目标项目是否允许共享。
|
||||
- 项目中已有但未索引的文件,优先原地接入,不重复复制。
|
||||
- 用户只描述规则时,先整理为拟写摘要并确认,不能把建议直接写成强制规则。
|
||||
|
||||
## 接入方案
|
||||
|
||||
1. 判断主题、适用目录、技术版本、规则级别和与既有规范的关系。
|
||||
2. 选择已有主题目录;没有合适位置时提出简短中性名称,不预设固定领域分类。
|
||||
3. 展示目标路径、正文来源、索引更新、冲突处理和是否需要更新 `.craftkit/project.json`。
|
||||
4. 用户确认后写入或保守合并,并在最近的有效索引中添加 Markdown 相对链接。
|
||||
5. 运行覆盖检查,再用 `guidance` 执行一次真实检索。
|
||||
|
||||
不得复制未获授权的参考项目规则、依赖库文档或公司知识库。公共资料只用于独立重建规则,并应记录来源、适用版本和必要的许可证信息。
|
||||
@@ -0,0 +1,20 @@
|
||||
# 规范覆盖检查
|
||||
|
||||
默认执行只读检查:
|
||||
|
||||
```powershell
|
||||
python scripts/check_index.py .craftkit/standards
|
||||
```
|
||||
|
||||
可通过 `--entry` 指定相对于规范根的其他入口,通过 `--json` 输出机器可读结果。
|
||||
|
||||
检查结果包括:
|
||||
|
||||
- 从入口沿 Markdown 相对链接可达的规范文件。
|
||||
- 规范根下未被入口索引到的 Markdown 文件。
|
||||
- 可达文件中的失效 Markdown 链接。
|
||||
- 索引图中的循环引用。
|
||||
|
||||
退出码:`0` 表示检查通过,`1` 表示发现覆盖问题,`2` 表示路径或入口无效。外部 URL、页内锚点和非 Markdown 资源不参与覆盖判定。
|
||||
|
||||
检查报告不自动修改文件。需要修复时先展示建议链接位置、相对路径和影响范围,用户确认后再编辑,并重新检查。
|
||||
@@ -0,0 +1,17 @@
|
||||
# 初始化或重组索引
|
||||
|
||||
## 分析
|
||||
|
||||
1. 确认 `.craftkit/standards/` 和入口 `index.md` 是否存在。
|
||||
2. 枚举规范 Markdown 文件,读取标题、链接和少量必要正文,识别现有主题与目录职责。
|
||||
3. 区分正式规范、索引、说明、草稿和历史资料;身份不明确时询问用户。
|
||||
4. 报告现有入口、失效引用、未索引文件、重复主题和潜在冲突。
|
||||
|
||||
## 设计
|
||||
|
||||
- 小型规范库可由根索引直接链接正文。
|
||||
- 内容较多或存在稳定主题目录时,可为该主题建立局部 `index.md`。
|
||||
- 保留项目已有且有效的目录结构,不为了统一外观移动正文。
|
||||
- 索引只承担导航、适用范围和优先级,不复制正文规则。
|
||||
|
||||
写入前展示新增与修改文件、每项链接目标以及不处理的文件。用户确认后保守修改索引;移动、重命名或删除正文需要单独授权。
|
||||
Reference in New Issue
Block a user