-
Notifications
You must be signed in to change notification settings - Fork 3
编写 HALF 系统用户手册 #6
Copy link
Copy link
Open
Labels
area:docsDocumentation, guides, and contributor docsDocumentation, guides, and contributor docsgood first issueGood for newcomersGood for newcomersstatus:readyTriaged and ready to pick upTriaged and ready to pick uptype:maintenanceRefactor, tooling, chores, or non-user-facing upkeepRefactor, tooling, chores, or non-user-facing upkeep
Milestone
Metadata
Metadata
Assignees
Labels
area:docsDocumentation, guides, and contributor docsDocumentation, guides, and contributor docsgood first issueGood for newcomersGood for newcomersstatus:readyTriaged and ready to pick upTriaged and ready to pick uptype:maintenanceRefactor, tooling, chores, or non-user-facing upkeepRefactor, tooling, chores, or non-user-facing upkeep
Problem
当前 README 和 quickstart 主要覆盖项目介绍、部署和首次启动,但缺少一份按实际 UI 流程组织的用户手册。新用户即使成功启动 HALF,也不容易理解项目、Agent、Plan、任务派发、Git 回写和执行总结之间的完整关系。
Proposed Change
新增中文用户手册,建议路径为
docs/user-manual.zh-CN.md。第一版手册聚焦“用户能看着文档完成最小闭环”,建议覆盖:
result.json完成判定和任务产物目录约定Why It Matters
用户手册是 v0.3 onboarding 工作的一部分,和 demo seed (#29)、README GIF (#39)、模板示例 (#30) 共同降低首次试用成本。
Additional Context
边界:
HALF_STRICT_SECURITYREADME.zh-CN.md文档列表中增加入口Acceptance Criteria
docs/user-manual.zh-CN.mdREADME.zh-CN.md增加用户手册链接result.json、查看总结