docs: develop task-guided Endor authoring skill and detailed handbook
This commit is contained in:
@@ -30,6 +30,12 @@
|
||||
- [ ] 页面能对应至少一个具体阅读目标。
|
||||
- [ ] 没有默认读者理解团队内部代称。
|
||||
|
||||
## 具体应用
|
||||
|
||||
用“已有知识 → 当前情境 → 读完能作出的判断”写页面目标,例子必须服务这个判断。若目标只能写成“了解更多”,先拆出具体问题再写提纲。
|
||||
|
||||
详见[信息架构](../references/information-architecture.md)与[身份指南](../examples/EX-01.md)。
|
||||
|
||||
## 依据与边界
|
||||
|
||||
[SRC-15](../research/SRC-15.md)、[SRC-14](../research/SRC-14.md)。来源页记录观察与分析,本页的执行方法是针对项目的综合建议,不宣称由某一原文逐项规定。
|
||||
|
||||
@@ -30,6 +30,12 @@
|
||||
- [ ] 标题与正文职责一致。
|
||||
- [ ] 无需为了分类创建没有内容的四套目录。
|
||||
|
||||
## 具体应用
|
||||
|
||||
根据读者是在学习、完成任务、查询精确规则还是理解原因选择页面职责。混合页只有在辅助内容不妨碍主任务时才保留;目录分类不要求四套内容都存在。
|
||||
|
||||
详见[指南任务](../tasks/TASK-02.md)与[模板选择](../templates/README.md)。
|
||||
|
||||
## 依据与边界
|
||||
|
||||
[SRC-14](../research/SRC-14.md)、[SRC-11](../research/SRC-11.md)。来源页记录观察与分析,本页的执行方法是针对项目的综合建议,不宣称由某一原文逐项规定。
|
||||
|
||||
@@ -30,6 +30,12 @@
|
||||
- [ ] 读者知道从哪里继续。
|
||||
- [ ] 概览没有变成全部规范的重复摘要。
|
||||
|
||||
## 具体应用
|
||||
|
||||
首页第一段建立对象与用途,随后给适用读者、当前文档性质和开始阅读路径。主要细节链接到章节,不能把所有作者约束堆到入口。
|
||||
|
||||
详见[指南任务](../tasks/TASK-02.md)与[入口与信息位置](../references/information-architecture.md)。
|
||||
|
||||
## 依据与边界
|
||||
|
||||
[SRC-01](../research/SRC-01.md)。来源页记录观察与分析,本页的执行方法是针对项目的综合建议,不宣称由某一原文逐项规定。
|
||||
|
||||
@@ -30,6 +30,12 @@
|
||||
- [ ] 涉及的名称有声明、前提或明确占位说明。
|
||||
- [ ] 没有虚构安装命令或运行入口。
|
||||
|
||||
## 具体应用
|
||||
|
||||
从例子里的每个名称倒查所需声明与概念,将影响合法性的条件放到使用点。全书已经介绍的背景可以短链接,直接跳入仍须看见局部假设。
|
||||
|
||||
详见[示例条件](../references/example-design.md)与[调用示范](../examples/EX-03.md)。
|
||||
|
||||
## 依据与边界
|
||||
|
||||
[SRC-04](../research/SRC-04.md)、[SRC-15](../research/SRC-15.md)。来源页记录观察与分析,本页的执行方法是针对项目的综合建议,不宣称由某一原文逐项规定。
|
||||
|
||||
@@ -30,6 +30,12 @@
|
||||
- [ ] 重要术语在正式使用前已定义或链接。
|
||||
- [ ] 目录调整没有改变语言语义。
|
||||
|
||||
## 具体应用
|
||||
|
||||
列出主题的理解前提,再为每条目录路径走查;预览允许先出现,但正式解释必须能回到定义。移动时保留旧内容到新位置的映射。
|
||||
|
||||
详见[依赖与目录](../references/information-architecture.md)与[重组示范](../examples/EX-05.md)。
|
||||
|
||||
## 依据与边界
|
||||
|
||||
[SRC-03](../research/SRC-03.md)、[SRC-09](../research/SRC-09.md)、[SRC-15](../research/SRC-15.md)。来源页记录观察与分析,本页的执行方法是针对项目的综合建议,不宣称由某一原文逐项规定。
|
||||
|
||||
@@ -30,6 +30,12 @@
|
||||
- [ ] 拆分页仍可独立阅读。
|
||||
- [ ] 没有仅因字数达到阈值而拆分。
|
||||
|
||||
## 具体应用
|
||||
|
||||
依据独立的读者问题、修改范围和查询需求决定分页。只有行数长不够成为拆分理由;拆开后必须来回跳转才能理解的最小规则应保持在一起。
|
||||
|
||||
详见[重组任务](../tasks/TASK-05.md)与[拆分与合并](../references/information-architecture.md)。
|
||||
|
||||
## 依据与边界
|
||||
|
||||
[SRC-09](../research/SRC-09.md)、[SRC-14](../research/SRC-14.md)。来源页记录观察与分析,本页的执行方法是针对项目的综合建议,不宣称由某一原文逐项规定。
|
||||
|
||||
@@ -30,6 +30,12 @@
|
||||
- [ ] 指定术语能定位到主要定义。
|
||||
- [ ] 作者资料不会混入语言学习主线。
|
||||
|
||||
## 具体应用
|
||||
|
||||
分别走查首页顺读、搜索直达和返回主定义三种路径。直接进入者需要一句局部上下文,而非完整复制前章;链接文字须能说明目标。
|
||||
|
||||
详见[三种入口](../references/information-architecture.md)与[定位验收](../references/review-rubric.md)。
|
||||
|
||||
## 依据与边界
|
||||
|
||||
[SRC-01](../research/SRC-01.md)、[SRC-07](../research/SRC-07.md)、[SRC-08](../research/SRC-08.md)。来源页记录观察与分析,本页的执行方法是针对项目的综合建议,不宣称由某一原文逐项规定。
|
||||
|
||||
@@ -30,6 +30,12 @@
|
||||
- [ ] 定义页可定位。
|
||||
- [ ] 相同规则没有多份相互矛盾的权威描述。
|
||||
|
||||
## 具体应用
|
||||
|
||||
为一个概念选择真实的主要定义,并让示例、索引和参考指向它。稳定编号是身份,文件排序和显示标题可以改变;迁移后检查引用实际支持的断言。
|
||||
|
||||
详见[定义迁移](../tasks/TASK-05.md)与[精确参考](../tasks/TASK-03.md)。
|
||||
|
||||
## 依据与边界
|
||||
|
||||
[SRC-02](../research/SRC-02.md)、[SRC-09](../research/SRC-09.md)。来源页记录观察与分析,本页的执行方法是针对项目的综合建议,不宣称由某一原文逐项规定。
|
||||
|
||||
@@ -30,6 +30,12 @@
|
||||
- [ ] 占位符没有冒充实际 API。
|
||||
- [ ] 示例标签与验证等级一致。
|
||||
|
||||
## 具体应用
|
||||
|
||||
先选择概念、源码片段、逻辑视图或实际执行等级,再填写归属、位置和依赖条件。最小示例可以很短,但其中每个名称都需要声明或明确假设。
|
||||
|
||||
详见[示例等级](../references/example-design.md)与[完整上下文](../examples/EX-03.md)。
|
||||
|
||||
## 依据与边界
|
||||
|
||||
[SRC-04](../research/SRC-04.md)、[SRC-08](../research/SRC-08.md)。来源页记录观察与分析,本页的执行方法是针对项目的综合建议,不宣称由某一原文逐项规定。
|
||||
|
||||
@@ -30,6 +30,12 @@
|
||||
- [ ] 结果与源码计算一致。
|
||||
- [ ] 效果说明没有被误标为执行日志。
|
||||
|
||||
## 具体应用
|
||||
|
||||
用确定输入推演关键中间结果和最终效果,然后解释数据或结构关系。报告预期结果与实际运行证据分别成立,源码旁不能省掉影响结果的条件。
|
||||
|
||||
详见[结果验证](../references/example-design.md)与[90 与 85 的推演](../examples/EX-03.md)。
|
||||
|
||||
## 依据与边界
|
||||
|
||||
[SRC-01](../research/SRC-01.md)、[SRC-02](../research/SRC-02.md)、[SRC-03](../research/SRC-03.md)、[SRC-04](../research/SRC-04.md)。来源页记录观察与分析,本页的执行方法是针对项目的综合建议,不宣称由某一原文逐项规定。
|
||||
|
||||
@@ -30,6 +30,12 @@
|
||||
- [ ] 新增概念有对应解释。
|
||||
- [ ] 一致场景不会强制所有专业例子使用商品。
|
||||
|
||||
## 具体应用
|
||||
|
||||
第二个例子改变一个有意义的条件,例如层级或后续调用。新增概念需要已有定义或短前提;不要为极简删除依赖声明,也不要堆进未定义的完整应用。
|
||||
|
||||
详见[递进判断](../references/example-design.md)与[示例任务](../tasks/TASK-04.md)。
|
||||
|
||||
## 依据与边界
|
||||
|
||||
[SRC-05](../research/SRC-05.md)。来源页记录观察与分析,本页的执行方法是针对项目的综合建议,不宣称由某一原文逐项规定。
|
||||
|
||||
@@ -30,6 +30,12 @@
|
||||
- [ ] 没有把所有失败称为语法错误。
|
||||
- [ ] 未定处理语法仍保持未定。
|
||||
|
||||
## 具体应用
|
||||
|
||||
选择读者容易违反的具体约束,按原因、可观察问题和最小修正解释。尚未规定的错误码与捕获语法保持未定;有意反例使用明确无效的 text 围栏。
|
||||
|
||||
详见[边界与阶段](../references/semantic-contracts.md)与[反例安排](../tasks/TASK-04.md)。
|
||||
|
||||
## 依据与边界
|
||||
|
||||
[SRC-02](../research/SRC-02.md)、[SRC-05](../research/SRC-05.md)。来源页记录观察与分析,本页的执行方法是针对项目的综合建议,不宣称由某一原文逐项规定。
|
||||
|
||||
@@ -30,6 +30,12 @@
|
||||
- [ ] 有可检查的效果。
|
||||
- [ ] 没有用底层机制替代语言契约。
|
||||
|
||||
## 具体应用
|
||||
|
||||
逐项说明形式、输入、结果、依赖、效果和必要的阶段边界;字段根据对象选择。use 应说明引用效果,不强填函数返回值;组件应说明子节点和排列。
|
||||
|
||||
详见[契约字段](../references/semantic-contracts.md)与[导入参考](../examples/EX-02.md)。
|
||||
|
||||
## 依据与边界
|
||||
|
||||
[SRC-02](../research/SRC-02.md)、[SRC-06](../research/SRC-06.md)。来源页记录观察与分析,本页的执行方法是针对项目的综合建议,不宣称由某一原文逐项规定。
|
||||
|
||||
@@ -30,6 +30,12 @@
|
||||
- [ ] 读者知道差异是否影响用法。
|
||||
- [ ] 没有为了比较而创造不存在的第二套 API。
|
||||
|
||||
## 具体应用
|
||||
|
||||
只比较真实存在的对象,并用相同情境或输入建立共同维度。选择理由必须对应读者的任务;未定设计比较保持候选身份,不能凭表格整齐引入第二套语法。
|
||||
|
||||
详见[解释与比较模板](../templates/TPL-04.md)与[页面职责](../references/information-architecture.md)。
|
||||
|
||||
## 依据与边界
|
||||
|
||||
[SRC-05](../research/SRC-05.md)、[SRC-06](../research/SRC-06.md)。来源页记录观察与分析,本页的执行方法是针对项目的综合建议,不宣称由某一原文逐项规定。
|
||||
|
||||
@@ -30,6 +30,12 @@
|
||||
- [ ] 没有新增未经确认的强制规则。
|
||||
- [ ] 同一状态声明不在每节重复。
|
||||
|
||||
## 具体应用
|
||||
|
||||
先读主要定义与规范状态,再检查全称词、默认值和示例成员。用户明确的新决定应落实准确范围,草案中仍未决定的签名、失败和权限不随之自动确定。
|
||||
|
||||
详见[断言依据](../references/language-map.md)与[决定与状态同步](../tasks/TASK-06.md)。
|
||||
|
||||
## 依据与边界
|
||||
|
||||
[SRC-02](../research/SRC-02.md)。来源页记录观察与分析,本页的执行方法是针对项目的综合建议,不宣称由某一原文逐项规定。
|
||||
|
||||
@@ -30,6 +30,12 @@
|
||||
- [ ] 实现选择没有伪装成语法限制。
|
||||
- [ ] 必要的存储说明限定在代码组织范围。
|
||||
|
||||
## 具体应用
|
||||
|
||||
描述代码输入、结果和可观察业务效果,而不把通信客户端、自动建表或缓存实现写成当前语言要求。系统实现的观测事实与语言决定分别记录。
|
||||
|
||||
详见[语言契约](../references/semantic-contracts.md)与[项目易错推断](../references/language-map.md)。
|
||||
|
||||
## 依据与边界
|
||||
|
||||
[SRC-06](../research/SRC-06.md)、[SRC-11](../research/SRC-11.md)。来源页记录观察与分析,本页的执行方法是针对项目的综合建议,不宣称由某一原文逐项规定。
|
||||
|
||||
@@ -30,6 +30,12 @@
|
||||
- [ ] 源码展示没有混入非源码标签。
|
||||
- [ ] 记法适用于从其他页面跳入的读者。
|
||||
|
||||
## 具体应用
|
||||
|
||||
检查正文、源码、标题、表格、链接文字和结果说明中的同一词。源码大小写与符号不能被中文排版替换;简称不自动成为正式更名请求。
|
||||
|
||||
详见[术语与标点](../references/chinese-style.md)与[局部修改](../tasks/TASK-01.md)。
|
||||
|
||||
## 依据与边界
|
||||
|
||||
[SRC-08](../research/SRC-08.md)、[SRC-15](../research/SRC-15.md)。来源页记录观察与分析,本页的执行方法是针对项目的综合建议,不宣称由某一原文逐项规定。
|
||||
|
||||
@@ -30,6 +30,12 @@
|
||||
- [ ] 代词指向明确。
|
||||
- [ ] 使用第二人称教学指令本身不被误判为问题。
|
||||
|
||||
## 具体应用
|
||||
|
||||
先提取原稿真正表达的断言,再写对象、行为、条件与后果。保留必要概念,删除必须依赖聊天才能理解的指代;合理的教程第二人称可保留。
|
||||
|
||||
详见[独立陈述](../references/chinese-style.md)与[完整改写](../examples/EX-01.md)。
|
||||
|
||||
## 依据与边界
|
||||
|
||||
[SRC-11](../research/SRC-11.md)、[SRC-15](../research/SRC-15.md)。来源页记录观察与分析,本页的执行方法是针对项目的综合建议,不宣称由某一原文逐项规定。
|
||||
|
||||
@@ -30,6 +30,12 @@
|
||||
- [ ] 源码可复制,结构示意不冒充源码。
|
||||
- [ ] Markdown 标题、列表与代码块正确闭合。
|
||||
|
||||
## 具体应用
|
||||
|
||||
重复字段用表格、步骤用列表、连续论证用段落。格式选择应帮助识别关系;每个提示只保留影响使用的重要条件,不追求固定标题数量。
|
||||
|
||||
详见[格式判断](../references/chinese-style.md)与[读者影响](../references/review-rubric.md)。
|
||||
|
||||
## 依据与边界
|
||||
|
||||
[SRC-03](../research/SRC-03.md)、[SRC-06](../research/SRC-06.md)。来源页记录观察与分析,本页的执行方法是针对项目的综合建议,不宣称由某一原文逐项规定。
|
||||
|
||||
@@ -30,6 +30,12 @@
|
||||
- [ ] 推断明确标记。
|
||||
- [ ] 无把搜索摘要冒充完整阅读的情况。
|
||||
|
||||
## 具体应用
|
||||
|
||||
从原页记录做法,再写作用分析和项目采用范围;三者不能互相替代。未取得正文时保留编号与状态,继续能完成的研究,不归纳未见观点。
|
||||
|
||||
详见[来源处理](../tasks/TASK-08.md)与[不可读来源场景](../evaluation/scenarios.md)。
|
||||
|
||||
## 依据与边界
|
||||
|
||||
本项目的来源核查流程;未读材料的处理记录见 [SRC-10](../research/SRC-10.md)、[SRC-12](../research/SRC-12.md)、[SRC-13](../research/SRC-13.md)。来源页记录观察与分析,本页的执行方法是针对项目的综合建议,不宣称由某一原文逐项规定。
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
## 执行方法
|
||||
|
||||
1. 修改前找出主定义和引用位置,编辑后复查影响范围。
|
||||
2. 运行链接、锚点、代码块、编号和格式检查;按风险检查例子与计算。
|
||||
2. 人工核对链接、锚点、代码块、编号和格式;按风险检查例子与计算。程序检查仅在用户明确要求执行时运行。
|
||||
3. 报告实际检查等级、未执行步骤与失败;工具通过不等于语言运行验证。
|
||||
|
||||
## 改写对照
|
||||
@@ -30,6 +30,12 @@
|
||||
- [ ] 命令和结果可复现。
|
||||
- [ ] 报告没有把静态检查称为编译或运行测试。
|
||||
|
||||
## 具体应用
|
||||
|
||||
根据本次断言与对象列出影响页,搜索词形和近义主张。修正后从主定义、文法、状态与例子双向核对,并记录相关读者任务的实际结果。
|
||||
|
||||
详见[影响范围](../tasks/TASK-06.md)与[工作记录](../templates/TPL-05.md)。
|
||||
|
||||
## 依据与边界
|
||||
|
||||
[SRC-07](../research/SRC-07.md)。来源页记录观察与分析,本页的执行方法是针对项目的综合建议,不宣称由某一原文逐项规定。
|
||||
|
||||
@@ -30,6 +30,12 @@
|
||||
- [ ] 工具无本机绝对路径。
|
||||
- [ ] 提交和推送状态有记录,权限不足不换用 owner 凭据。
|
||||
|
||||
## 具体应用
|
||||
|
||||
让入口、任务索引、相对引用和必要主定义可从仓库重新取得。独立 skill 包携带写作资源,真实写作仍读取目标语言仓库;不要复制某台电脑的凭据或会话配置。
|
||||
|
||||
详见[跨电脑使用](../skill-usage.md)与[手册维护](../tasks/TASK-08.md)。
|
||||
|
||||
## 依据与边界
|
||||
|
||||
[SRC-11](../research/SRC-11.md)、[SRC-07](../research/SRC-07.md)。来源页记录观察与分析,本页的执行方法是针对项目的综合建议,不宣称由某一原文逐项规定。
|
||||
|
||||
@@ -30,6 +30,12 @@
|
||||
- [ ] 改动说明含适用规则与验证。
|
||||
- [ ] 作者身份不影响语义确认要求。
|
||||
|
||||
## 具体应用
|
||||
|
||||
人工与 AI 都要交付有依据的成稿或可实施发现。审查-only 保留文件,修复任务完成相关修改;已获授权无需重复请求,但新语义仍需准确依据。
|
||||
|
||||
详见[统一任务入口](../SKILL.md)与[审查边界](../tasks/TASK-07.md)。
|
||||
|
||||
## 依据与边界
|
||||
|
||||
[SRC-07](../research/SRC-07.md)。来源页记录观察与分析,本页的执行方法是针对项目的综合建议,不宣称由某一原文逐项规定。
|
||||
|
||||
@@ -30,6 +30,12 @@
|
||||
- [ ] 发现的理解障碍有具体位置。
|
||||
- [ ] 没有把作者自查冒充真实用户测试。
|
||||
|
||||
## 具体应用
|
||||
|
||||
选择相关的复述、定位或预测任务,记录实际卡住的位置。作者走查、独立代理评估和真人测试分别报告;质量不能由链接数量或规则命中数推断。
|
||||
|
||||
详见[验收标准](../references/review-rubric.md)与[行为评估](../evaluation/scenarios.md)。
|
||||
|
||||
## 依据与边界
|
||||
|
||||
[SRC-15](../research/SRC-15.md)。来源页记录观察与分析,本页的执行方法是针对项目的综合建议,不宣称由某一原文逐项规定。
|
||||
|
||||
Reference in New Issue
Block a user