docs: develop task-guided Endor authoring skill and detailed handbook
This commit is contained in:
@@ -8,6 +8,8 @@
|
||||
| TPL-02 | [任务指南](TPL-02.md) | 已有前提下完成一个明确操作 |
|
||||
| TPL-03 | [语法或 API 参考](TPL-03.md) | 查询形式、参数、约束和效果 |
|
||||
| TPL-04 | [概念解释与比较](TPL-04.md) | 理解关系、设计理由或替代方案 |
|
||||
| TPL-05 | [变更工作单](TPL-05.md) | 记录较大修改的依据、影响与验证,不属于读者正文 |
|
||||
| TPL-06 | [审查报告](TPL-06.md) | 交付有证据、可实施的问题与建议 |
|
||||
|
||||
模板借鉴 [Diátaxis 的职责区分](../research/SRC-14.md),是本项目的页面组织建议。概念指南可以结合少量讲解与示例;尚无执行环境时不将它包装成可运行教程。
|
||||
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
# TPL-05 变更工作单
|
||||
|
||||
用途:为跨章、语义或较大新增任务记录决策依据与影响范围。可以写在任务笔记或提交说明中,不要求每次新增持久文件。错字修正通常不需要此模板。
|
||||
|
||||
````markdown
|
||||
## 本次读者目标
|
||||
|
||||
已有背景:
|
||||
希望读完能完成的判断或操作:
|
||||
主任务与补充任务:
|
||||
采用的 DOC 规则与方法页:
|
||||
|
||||
## 依据与状态
|
||||
|
||||
| 断言或决定 | 依据位置 | 当前状态 | 本次是否改变 |
|
||||
| --- | --- | --- | --- |
|
||||
| 填入关键断言 | 主定义或用户明确决定 | 确定/提案/未定 | 具体变化 |
|
||||
|
||||
## 影响范围
|
||||
|
||||
| 主要修改 | 关联页 | 必须同步的内容 |
|
||||
| --- | --- | --- |
|
||||
| 文件及小节 | 文件或锚点 | 例子/文法/状态/术语/导航 |
|
||||
|
||||
## 验证
|
||||
|
||||
结构检查:
|
||||
语义与示例核对:
|
||||
相关读者任务:
|
||||
实际执行或真人测试:
|
||||
仍需决定的具体问题:
|
||||
````
|
||||
|
||||
使用后删去无关栏目。依据写到能定位,不只写“用户说过”或“参考其他语言”。未执行的验证写明未执行,不填预期通过。
|
||||
|
||||
[模板目录](README.md) · [语义变更任务](../tasks/TASK-06.md)
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
# TPL-06 文档审查报告
|
||||
|
||||
用途:交付有证据、可修正的审查结果。没有实质发现时直接说明范围与验证,不为了填模板创造问题。
|
||||
|
||||
````markdown
|
||||
审查对象与读者目标:
|
||||
已覆盖与未覆盖的范围:
|
||||
|
||||
## 发现
|
||||
|
||||
### 优先级:具体问题
|
||||
|
||||
位置:
|
||||
原文断言或缺少的必要条件:
|
||||
主定义/规则依据:
|
||||
读者会受到的影响:
|
||||
最小修正:
|
||||
是否已修复:
|
||||
|
||||
## 验证与剩余问题
|
||||
|
||||
结构检查结果:
|
||||
读者任务走查:
|
||||
未执行的检查:
|
||||
需要语言决定的具体缺口:
|
||||
````
|
||||
|
||||
实际报告可用紧凑段落或表格承载上述信息,不必照搬六个标签。审查-only 请求只报告发现;有修复授权时先修正再写结果。
|
||||
|
||||
[模板目录](README.md) · [审查任务](../tasks/TASK-07.md)
|
||||
|
||||
Reference in New Issue
Block a user