docs: develop task-guided Endor authoring skill and detailed handbook
This commit is contained in:
+7
-5
@@ -4,13 +4,15 @@
|
||||
|
||||
## 开始阅读
|
||||
|
||||
首次参与先读 [AGENTS.md](AGENTS.md)、[作者手册](authoring/README.md)及目标章节的主要定义。每次改动按[工作流](authoring/workflow.md)选择适用规则。
|
||||
首次参与先读 [AGENTS.md](AGENTS.md)、[endor-docs skill](authoring/SKILL.md)及目标章节的主要定义。每次改动从[作者手册](authoring/README.md)选择任务,查阅对应小节和注意事项,再按[工作流](authoring/workflow.md)完成修改。
|
||||
|
||||
本轮写作标准不改变语言设计稿的确定程度。提案确认需要明确的语言决定,不能仅凭修订文档或加入模板获得确认。
|
||||
任务页直接列出必读方法、规则、案例和注意事项,每次实际查阅后再编写。项目级 skill 入口与跨电脑使用见[说明](authoring/skill-usage.md)。
|
||||
|
||||
写作标准不改变语言设计稿的确定程度。提案确认需要明确的语言决定,不能仅凭修订文档或加入模板获得确认。
|
||||
|
||||
## 本地检查
|
||||
|
||||
检查工具只依赖 Python 3.10 或更新版本的标准库:
|
||||
默认人工核对主定义、文法、例子、链接和状态。只有用户明确要求执行检查时,才使用仓库保留的工具;它们依赖 Python 3.10 或更新版本的标准库:
|
||||
|
||||
```sh
|
||||
python3 tools/check_docs.py
|
||||
@@ -41,9 +43,9 @@ ssh://git@gitea.entroia.com:22222/Zayden-Jung/Endorphin-Document.git
|
||||
|
||||
## 修改与交付
|
||||
|
||||
开始前检查分支与未提交改动,保留其他作者的编辑。修改后核对主定义、例子、文法、目录与状态,再审查暂存范围。
|
||||
开始前保留其他作者的编辑。修改后核对主定义、例子、文法、目录与状态;用户明确要求提交时,再检查 Git 分支、未提交改动和暂存范围。
|
||||
|
||||
仅在用户授权时提交或推送,不强推覆盖远端。权限不足时保留本地工作,请用户为 codex-bot 授予权限,不切换账号。
|
||||
仅在用户授权时提交或推送,不强推覆盖远端,不附带启动测试或项目 hook。权限不足时保留本地工作,请用户为 codex-bot 授予权限,不切换账号。
|
||||
|
||||
交付报告使用中文,说明提交标识、推送状态、检查结果,以及每个修改文件的目的与内容。可以按共同目的分组,但新增、移动或删除文件也需要覆盖。
|
||||
|
||||
|
||||
Reference in New Issue
Block a user