58 lines
4.8 KiB
Markdown
58 lines
4.8 KiB
Markdown
---
|
|
name: endor-docs
|
|
description: 编写、修订、重组和审查本仓库的 Endorphin（用户也称 Endor）语言文档；按任务读取写作手册、核对语言决定、完善示例和参考、检查跨章节一致性。用于文档工作及本手册维护，不用于实现语言运行系统。
|
|
---
|
|
|
|
# Endor 文档写作
|
|
|
|
为首次阅读者建立正确的语言模型，为查阅者提供足以判断写法和效果的局部信息。交付可直接阅读和继续维护的 Markdown；审查请求交付具体问题及证据。
|
|
|
|
## 进入任务
|
|
|
|
1. 确认目标文档仓库，读取其 AGENTS.md、目标页和关联的主要定义；保留已有修改。用户已说明的目标和授权继续有效。
|
|
2. 从下表选择主任务。任务同时涉及示例、语义或章节结构时，合并对应路线，去重读取。不要为小改动通读手册。
|
|
3. 读取选中任务页、其必读方法和对应 DOC 规则。新增或改变语言断言时，再读取[语言核对地图](references/language-map.md)及目标主题的规范状态。
|
|
4. 形成简短工作记录：读者要完成什么、主要定义在哪里、已知与未定项、预计修改页、采用路线。可写在工作笔记或交付说明，无需每次新增文件。
|
|
|
|
| 用户想做什么 | 主任务 | 执行页 |
|
|
| --- | --- | --- |
|
|
| 修正措辞、术语、链接、错字 | edit | [TASK-01 局部修改](tasks/TASK-01.md) |
|
|
| 新写或补全一章，让初学者看懂 | guide | [TASK-02 指南写作](tasks/TASK-02.md) |
|
|
| 查询语法、参数、约束、结果 | reference | [TASK-03 精确参考](tasks/TASK-03.md) |
|
|
| 新增、修复或统一示例 | example | [TASK-04 示例工程](tasks/TASK-04.md) |
|
|
| 调整目录、分页、定义位置 | structure | [TASK-05 信息架构](tasks/TASK-05.md) |
|
|
| 落实用户确认的语言决定、修正文档矛盾 | semantics | [TASK-06 语义变更](tasks/TASK-06.md) |
|
|
| 检查质量、指出问题、评审草稿 | review | [TASK-07 文档审查](tasks/TASK-07.md) |
|
|
| 研究来源、改进手册或本 skill | research | [TASK-08 手册维护](tasks/TASK-08.md) |
|
|
|
|
按任务表直接打开相应小节，再用[语言核对地图](references/language-map.md)查找主题主定义。每次实际阅读所需内容；列出阅读清单不能代替阅读。
|
|
|
|
项目级入口和跨电脑使用见[使用说明](skill-usage.md)。整个查询流程通过 Markdown 完成。
|
|
|
|
## 写作中的关键判断
|
|
|
|
- 先明确一页要解决的读者问题，再决定小节与篇幅。读者熟悉编程，不代表熟悉本语言的归属和调用模型。
|
|
- 以仓库主定义和用户明确决定为依据。发现冲突时定位冲突范围；能独立完成的措辞、结构与链接工作继续进行，受未定语义影响的部分标明具体缺口。
|
|
- 任何新增能力、默认值、错误语法或名称查找行为都需要依据。示例完整性不能靠编造语言能力补足。按[语义契约](references/semantic-contracts.md)处理。
|
|
- 每个关键示例交代位置、依赖、输入和可观察效果。数值手算与实际执行分别记录；采用[示例方法](references/example-design.md)。
|
|
- 保留统一主定义；导航页、参考、例子各司其职。使用模板时根据内容删减栏目，写成连贯的说明。
|
|
- 用户说“Endor”时可识别为本项目；当前正文正式名称和代码围栏以仓库约定为准。只有明确更名请求才做全库更名。
|
|
|
|
## 完成与交付
|
|
|
|
按[工作流](workflow.md)完成影响核对与[质量验收](references/review-rubric.md)。修复与任务相关的问题，直到结果满足读者目标；不同意某条建议时给出具体理由，不能仅为打勾而改文。
|
|
|
|
默认通过阅读与文件编辑完成工作，人工核对链接、条件、例子与跨章一致性。只有用户明确要求执行代码时，才运行程序、脚本、测试、构建或安装命令；存在工具、运行环境或旧检查清单，都不构成执行授权。用户明确要求的 commit、push 按该授权执行，不能借此附带运行测试或项目 hook。
|
|
|
|
审查本身只读，用户同时授权修复时再改文件。提交和推送沿用当前用户授权及仓库身份约定，skill 不自动增加外部操作权限。
|
|
|
|
交付说明结果、涉及文件及目的、采用的路线和关键规则、实际验证与剩余具体缺口。不要输出整张空检查表，不宣称结构检查证明了语义或可用性。
|
|
|
|
## 深入查阅
|
|
|
|
- [手册入口](README.md)：人类读者的完整目录、问题索引与 24 条原则。
|
|
- [语言核对地图](references/language-map.md)：项目特有的易错语义和主定义。
|
|
- [完整改写示例](examples/README.md)：从原稿、判断到成稿和验收。
|
|
- [行为评估](evaluation/scenarios.md)：修改 skill 后验证实际决策。
|
|
- [研究总览](research/synthesis.md)：方法来源及适用边界。
|