docs: develop task-guided Endor authoring skill and detailed handbook
This commit is contained in:
+11
-11
@@ -4,7 +4,7 @@
|
||||
|
||||
## 1. 开始前
|
||||
|
||||
读取仓库 [AGENTS.md](../AGENTS.md)、[手册入口](README.md)和目标主题的主要定义。检查当前分支、远端与工作区;已有未提交修改属于原作者,未经授权不清除或覆盖。
|
||||
读取仓库 AGENTS.md、[SKILL.md](SKILL.md)和目标主题的主要定义。保留已有修改;用户明确要求提交或推送时,再完成必要 Git 状态检查。独立安装的 skill 以指定目标仓库为准,不以当前目录猜测项目。
|
||||
|
||||
记录:
|
||||
|
||||
@@ -16,6 +16,10 @@
|
||||
|
||||
## 2. 选择相关规则
|
||||
|
||||
先从[任务索引](README.md#按任务进入)选择路线,读取任务页及其指定方法、DOC 规则和案例。可合并任务;路线是本次工作的阅读范围,不是必须逐项填满的表单。
|
||||
|
||||
直接打开任务页列出的对应小节,实际阅读后再写作。纯错字修正走 edit;若出现语义强度变化,补 semantics;审查-only 走 review 并保持文件未改。
|
||||
|
||||
| 改动 | 最少阅读的相关规则 |
|
||||
| --- | --- |
|
||||
| 错字、链接或术语 | DOC-017、021 |
|
||||
@@ -24,25 +28,19 @@
|
||||
| 外部资料研究 | DOC-020;再根据结论选相关规则 |
|
||||
| AI 或跨电脑接续 | DOC-022、023;再选任务适用规则 |
|
||||
|
||||
这是起点,不替代按风险判断。引用规则页见[规则索引](README.md#规则索引)。
|
||||
本表概括常用规则;完整必读资源以所选任务页为准。引用规则页见[规则索引](README.md#规则索引)。
|
||||
|
||||
## 3. 编辑
|
||||
|
||||
先修改主要定义,再同步依赖内容。使用适用的[模板](templates/README.md),但不要填满与主题无关的栏目。
|
||||
先修改主要定义,再同步依赖内容。使用适用的[模板](templates/README.md),但不要填满与主题无关的栏目。较大改动可用[TPL-05 工作单](templates/TPL-05.md)记录读者目标、断言依据和影响页。
|
||||
|
||||
语法提案保持提案身份。涉及新的语言决定时,说明所需决定而不擅自补造语法。研究与作者规则放在 authoring,不混入读者语言主线。
|
||||
|
||||
## 4. 验证
|
||||
|
||||
在仓库根目录执行:
|
||||
默认人工核对示例计算、归属与引用、文法、链接及局部假设,并按[审查标准](references/review-rubric.md)走查相关读者任务。记录阻断问题是否消除、重要缺口是否处理、哪些检查不适用及原因。检查清单见 [checklist.md](checklist.md)。
|
||||
|
||||
```sh
|
||||
python3 tools/check_docs.py
|
||||
python3 -m unittest discover -s tools/tests -v
|
||||
git diff --check
|
||||
```
|
||||
|
||||
另行核对示例计算、归属与引用、文法及局部假设,并执行[读者任务检查](rules/DOC-024.md)。检查清单见 [checklist.md](checklist.md)。
|
||||
只有用户明确要求执行代码时,才运行程序、脚本、测试或其他自动检查。已有工具、旧清单和完成目标都不构成执行授权;不擅自安装验证依赖。
|
||||
|
||||
工具只验证结构及有限约定,不证明语言可编译、程序正确或文档易懂。新工具的检查能力以 [tools/README.md](../tools/README.md) 为准。
|
||||
|
||||
@@ -59,4 +57,6 @@ git diff --check
|
||||
|
||||
另一作者从仓库文件和 Git 状态开始,不依赖聊天记忆。维护手册时保留 DOC、SRC 和 TPL 编号;新增来源先登记访问状态。
|
||||
|
||||
修改 skill 的任务入口、方法或核心约束后,选择[评估场景](evaluation/scenarios.md)走查实际任务与产物。人工结构核对、作者走查和独立测试分别记录;改进依据是观察到的决策缺口。
|
||||
|
||||
[手册入口](README.md) · [贡献流程](../CONTRIBUTING.md)
|
||||
|
||||
Reference in New Issue
Block a user