跳转至

快速上手

你需要做什么

如果你是团队成员,按下面步骤加入协作。

1. Clone 仓库

bash git clone https://github.com/alpc91/harness.git cd harness

2. 用 Obsidian 打开 vault

打开 Obsidian,选择:

text Open folder as vault

然后选择:

text harness/vault/

这个文件夹就是团队知识库工作台。

3. 用 Codex 或 Claude Code 打开仓库

打开仓库根目录:

text harness/

让 Agent 先读:

text AGENTS.md CLAUDE.md vault/90-system/AGENTS.md

4. 常用任务

把讨论放进 inbox:

text 把这段群聊讨论整理进 vault/00-inbox,并保留日期、来源和待处理事项。

把 inbox 编译成知识页:

text 把 vault/00-inbox 里的新材料 ingest 成 vault/20-wiki 和 vault/40-decisions 页面,并更新 index/log。

把成熟内容发布到网站:

text 把这个 wiki 页面整理成 docs 页面,更新 mkdocs.yml 导航,并运行构建验证。

5. 提交前检查

Windows:

powershell .\scripts\check.ps1

通用命令:

bash python scripts/vault_lint.py python -m uv run mkdocs build --strict

6. 提交 PR

提交内容前确认:

  • 没有 API key、token、密码。
  • raw 资料没有被随意改写。
  • wiki 页面有“本页回答的问题”和“核心结论”。
  • ADR 有背景、决策、理由、影响。
  • 成熟内容才发布到 docs/

你不需要一开始做什么

第一阶段不强制:

  • 购买 Obsidian Sync。
  • 搭 MCP。
  • 写自定义 skill。
  • 所有人都装 Obsidian。
  • 完全自动化群聊抓取。

先把最小闭环跑顺。