Skip to content

编写 HALF 系统用户手册 #6

@keting

Description

@keting

Problem

当前 README 和 quickstart 主要覆盖项目介绍、部署和首次启动,但缺少一份按实际 UI 流程组织的用户手册。新用户即使成功启动 HALF,也不容易理解项目、Agent、Plan、任务派发、Git 回写和执行总结之间的完整关系。

Proposed Change

新增中文用户手册,建议路径为 docs/user-manual.zh-CN.md

第一版手册聚焦“用户能看着文档完成最小闭环”,建议覆盖:

  • HALF 的产品边界:不自动调用 Agent,只负责任务编排、Prompt handoff 和 Git 轮询
  • 首次登录后的推荐流程
  • 项目页 / 新建项目 / 项目详情
  • Agent 管理
  • 流程模板 / 工作流预设的使用入口
  • Plan 规划页:模板方式与 Prompt 方式
  • 任务执行页:复制 Prompt、重新派发、手动完成、放弃任务
  • 执行总结页
  • result.json 完成判定和任务产物目录约定
  • 常见问题

Why It Matters

用户手册是 v0.3 onboarding 工作的一部分,和 demo seed (#29)、README GIF (#39)、模板示例 (#30) 共同降低首次试用成本。

Additional Context

边界:

  • 不重复 quickstart 的完整部署说明,只链接到 quickstart
  • 不在主流程中推荐关闭 HALF_STRICT_SECURITY
  • Windows / 代理 / Clash 等环境经验如需保留,应放在附录或 troubleshooting 中,并标明是特定环境参考
  • 图片必须使用仓库相对路径
  • 手册合并后应在 README.zh-CN.md 文档列表中增加入口

Acceptance Criteria

  • 新增 docs/user-manual.zh-CN.md
  • README.zh-CN.md 增加用户手册链接
  • 手册能覆盖一次完整最小闭环:创建项目、生成计划、派发任务、Agent 写回 result.json、查看总结
  • 所有图片在 GitHub 页面可正常显示
  • 不包含本机绝对路径、个人环境路径或不安全配置建议

Metadata

Metadata

Assignees

Labels

area:docsDocumentation, guides, and contributor docsgood first issueGood for newcomersstatus:readyTriaged and ready to pick uptype:maintenanceRefactor, tooling, chores, or non-user-facing upkeep

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions