From 2da848a1d986f30a6514c3d31d05f70c9a5b9473 Mon Sep 17 00:00:00 2001 From: Jesse Date: Tue, 28 Jul 2026 14:39:29 +0800 Subject: [PATCH] docs: configure agent engineering workflows --- AGENTS.md | 14 +++++ CONTEXT.md | 49 ++++++++++++++++++ ...arate-agent-failures-from-reply-ratings.md | 7 +++ ...and-expire-conversation-quality-content.md | 7 +++ docs/agents/domain.md | 51 +++++++++++++++++++ docs/agents/issue-tracker.md | 45 ++++++++++++++++ docs/agents/triage-labels.md | 15 ++++++ 7 files changed, 188 insertions(+) create mode 100644 CONTEXT.md create mode 100644 docs/adr/0001-separate-agent-failures-from-reply-ratings.md create mode 100644 docs/adr/0002-minimize-and-expire-conversation-quality-content.md create mode 100644 docs/agents/domain.md create mode 100644 docs/agents/issue-tracker.md create mode 100644 docs/agents/triage-labels.md diff --git a/AGENTS.md b/AGENTS.md index b77987c7..ced21830 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -153,3 +153,17 @@ Deployment safety rules: 4. 若当轮只能诊断或被阻塞，也要把已确认事实写成 `investigating` 或 `blocked`，不得编造根因或提前标记 `resolved`。 5. `resolved` 必须有与风险相称的证据：至少一个针对性回归测试；生产问题还必须有脱敏后的迁移、部署、健康检查或 smoke 证据。 6. Bug 历史严禁写入姓名、出生资料、邮箱、用户/案例 ID、Cookie、JWT、密码、密钥、完整请求体或模型原文。 + +## Agent skills + +### Issue tracker + +Issues and PRDs are tracked in this repository's GitHub Issues using the `gh` CLI. See `docs/agents/issue-tracker.md`. + +### Triage labels + +Triage uses the canonical `needs-triage`, `needs-info`, `ready-for-agent`, `ready-for-human`, and `wontfix` labels. See `docs/agents/triage-labels.md`. + +### Domain docs + +Domain documentation uses the single-context layout. See `docs/agents/domain.md`. diff --git a/CONTEXT.md b/CONTEXT.md new file mode 100644 index 00000000..e34f2c1c --- /dev/null +++ b/CONTEXT.md @@ -0,0 +1,49 @@ +# Jyotisha 产品领域 + +本上下文定义 Jyotisha Agent 对话、回复质量与后台排错所使用的统一业务语言。 + +## Language + +**Agent 会话**： +用户与某一种 Jyotisha Agent 持续交互的容器，例如普通咨询或出生时间校正。 +_避免使用_：聊天记录、咨询（用于泛指所有 Agent 场景时） + +**Agent 对话轮次**： +在 Agent 会话中，从用户输入触发 Agent 生成一条回复开始，到 Agent 完整回复或该次回复失败为止的一次交互。 +_避免使用_：单条消息、一轮对话 + +**Agent 执行尝试**： +使用独立请求标识执行一个 Agent 对话轮次的一次尝试；重试同一轮次会产生新的尝试。 +_避免使用_：重复消息、同一请求 + +**Agent 执行故障**： +Agent 执行尝试因技术异常未能正常产出完整回复。未登录、余额不足和参数不合法等预期业务拒绝不属于执行故障。 +_避免使用_：所有失败请求、报错 + +**未完成回复**： +Agent 执行故障发生前已经展示给用户、但未正常结束的 Agent 输出。 +_避免使用_：正常回复、可评价回复 + +**故障诊断摘要**： +面向管理员的结构化脱敏故障说明，可用于定位执行阶段和失败类型，但不包含敏感原始诊断内容。 +_避免使用_：原始异常、完整日志 + +**故障上下文快照**： +为排查 Agent 执行故障而保留的故障轮次及该次执行实际使用的近期上下文，不等同于完整会话副本。 +_避免使用_：完整聊天记录、错误消息 + +**回复评价**： +用户针对一条完整 Agent 回复提交的当前正向或负向质量判断。评价属于具体回复，而不是整个 Agent 会话。 +_避免使用_：会话评分、点赞记录 + +**不满意原因**： +负向回复评价附带的一个或多个原因分类，可包含用户补充说明。 +_避免使用_：投诉、差评文本 + +**对话质量记录**： +管理后台中供管理员排查或审阅的一项 Agent 执行故障或负向回复评价。 +_避免使用_：聊天日志、客服工单 + +**处理状态**： +对话质量记录的内部处理进度，取值为待处理、处理中、已解决或忽略。 +_避免使用_：用户反馈状态、通知状态 diff --git a/docs/adr/0001-separate-agent-failures-from-reply-ratings.md b/docs/adr/0001-separate-agent-failures-from-reply-ratings.md new file mode 100644 index 00000000..e2f6f626 --- /dev/null +++ b/docs/adr/0001-separate-agent-failures-from-reply-ratings.md @@ -0,0 +1,7 @@ +--- +status: accepted +--- + +# 分离 Agent 执行故障与回复评价 + +所有 Agent 会话使用稳定的会话、轮次、回复、执行尝试和请求标识建立关联，但将技术执行故障与用户对完整回复的质量评价建模为两类记录；服务端和客户端故障按请求标识关联去重，重复执行按轮次聚合展示。这样可以分别衡量系统可用性与回答质量，并保留重试轨迹，而不会把业务拒绝、技术失败和内容不满意混成同一种“报错”。 diff --git a/docs/adr/0002-minimize-and-expire-conversation-quality-content.md b/docs/adr/0002-minimize-and-expire-conversation-quality-content.md new file mode 100644 index 00000000..fcf44d7f --- /dev/null +++ b/docs/adr/0002-minimize-and-expire-conversation-quality-content.md @@ -0,0 +1,7 @@ +--- +status: accepted +--- + +# 最小化并限期保留对话质量正文 + +对话质量记录按排错需要最小化收集：执行故障保存实际使用的上下文，负向评价保存对应 Agent 对话轮次，正向评价只保存脱敏统计元数据；禁止保存密钥、认证信息、系统提示词、原始第三方响应和完整堆栈。故障及负向评价正文最多保留 90 天，用户删除会话或撤回负向评价时提前清除相关正文；不可还原对话的聚合数据、审计轨迹和脱敏管理员备注可以长期保留，以平衡问题追踪与用户隐私。 diff --git a/docs/agents/domain.md b/docs/agents/domain.md new file mode 100644 index 00000000..b548c538 --- /dev/null +++ b/docs/agents/domain.md @@ -0,0 +1,51 @@ +# Domain Docs + +How the engineering skills should consume this repo's domain documentation when exploring the codebase. + +## Before exploring, read these + +- **`CONTEXT.md`** at the repo root, or +- **`CONTEXT-MAP.md`** at the repo root if it exists — it points at one `CONTEXT.md` per context. Read each one relevant to the topic. +- **`docs/adr/`** — read ADRs that touch the area you're about to work in. In multi-context repos, also check `src//docs/adr/` for context-scoped decisions. + +If any of these files don't exist, **proceed silently**. Don't flag their absence; don't suggest creating them upfront. The `/domain-modeling` skill (reached via `/grill-with-docs` and `/improve-codebase-architecture`) creates them lazily when terms or decisions actually get resolved. + +## File structure + +Single-context repo (most repos): + +``` +/ +├── CONTEXT.md +├── docs/adr/ +│ ├── 0001-event-sourced-orders.md +│ └── 0002-postgres-for-write-model.md +└── src/ +``` + +Multi-context repo (presence of `CONTEXT-MAP.md` at the root): + +``` +/ +├── CONTEXT-MAP.md +├── docs/adr/ ← system-wide decisions +└── src/ + ├── ordering/ + │ ├── CONTEXT.md + │ └── docs/adr/ ← context-specific decisions + └── billing/ + ├── CONTEXT.md + └── docs/adr/ +``` + +## Use the glossary's vocabulary + +When your output names a domain concept (in an issue title, a refactor proposal, a hypothesis, a test name), use the term as defined in `CONTEXT.md`. Don't drift to synonyms the glossary explicitly avoids. + +If the concept you need isn't in the glossary yet, that's a signal — either you're inventing language the project doesn't use (reconsider) or there's a real gap (note it for `/domain-modeling`). + +## Flag ADR conflicts + +If your output contradicts an existing ADR, surface it explicitly rather than silently overriding: + +> _Contradicts ADR-0007 (event-sourced orders) — but worth reopening because…_ diff --git a/docs/agents/issue-tracker.md b/docs/agents/issue-tracker.md new file mode 100644 index 00000000..82cfbf5b --- /dev/null +++ b/docs/agents/issue-tracker.md @@ -0,0 +1,45 @@ +# Issue tracker: GitHub + +Issues and PRDs for this repo live as GitHub issues. Use the `gh` CLI for all operations. + +## Conventions + +- **Create an issue**: `gh issue create --title "..." --body "..."`. Use a heredoc for multi-line bodies. +- **Read an issue**: `gh issue view --comments`, filtering comments by `jq` and also fetching labels. +- **List issues**: `gh issue list --state open --json number,title,body,labels,comments --jq '[.[] | {number, title, body, labels: [.labels[].name], comments: [.comments[].body]}]'` with appropriate `--label` and `--state` filters. +- **Comment on an issue**: `gh issue comment --body "..."` +- **Apply / remove labels**: `gh issue edit --add-label "..."` / `--remove-label "..."` +- **Close**: `gh issue close --comment "..."` + +Infer the repo from `git remote -v` — `gh` does this automatically when run inside a clone. + +## Pull requests as a triage surface + +**PRs as a request surface: no.** _(Set to `yes` if this repo treats external PRs as feature requests; `/triage` reads this flag.)_ + +When set to `yes`, PRs run through the same labels and states as issues, using the `gh pr` equivalents: + +- **Read a PR**: `gh pr view --comments` and `gh pr diff ` for the diff. +- **List external PRs for triage**: `gh pr list --state open --json number,title,body,labels,author,authorAssociation,comments` then keep only `authorAssociation` of `CONTRIBUTOR`, `FIRST_TIME_CONTRIBUTOR`, or `NONE` (drop `OWNER`/`MEMBER`/`COLLABORATOR`). +- **Comment / label / close**: `gh pr comment`, `gh pr edit --add-label`/`--remove-label`, `gh pr close`. + +GitHub shares one number space across issues and PRs, so a bare `#42` may be either — resolve with `gh pr view 42` and fall back to `gh issue view 42`. + +## When a skill says "publish to the issue tracker" + +Create a GitHub issue. + +## When a skill says "fetch the relevant ticket" + +Run `gh issue view --comments`. + +## Wayfinding operations + +Used by `/wayfinder`. The **map** is a single issue with **child** issues as tickets. + +- **Map**: a single issue labelled `wayfinder:map`, holding the Notes / Decisions-so-far / Fog body. `gh issue create --label wayfinder:map`. +- **Child ticket**: an issue linked to the map as a GitHub sub-issue (`gh api` on the sub-issues endpoint). Where sub-issues aren't enabled, add the child to a task list in the map body and put `Part of #` at the top of the child body. Labels: `wayfinder:` (`research`/`prototype`/`grilling`/`task`). Once claimed, the ticket is assigned to the driving dev. +- **Blocking**: GitHub's **native issue dependencies** — the canonical, UI-visible representation. Add an edge with `gh api --method POST repos///issues//dependencies/blocked_by -F issue_id=`, where `` is the blocker's numeric **database id** (`gh api repos///issues/ --jq .id`, _not_ the `#number` or `node_id`). GitHub reports `issue_dependencies_summary.blocked_by` (open blockers only — the live gate). Where dependencies aren't available, fall back to a `Blocked by: #, #` line at the top of the child body. A ticket is unblocked when every blocker is closed. +- **Frontier query**: list the map's open children (`gh issue list --state open`, scoped to the map's sub-issues / task list), drop any with an open blocker (`issue_dependencies_summary.blocked_by > 0`, or an open issue in the `Blocked by` line) or an assignee; first in map order wins. +- **Claim**: `gh issue edit --add-assignee @me` — the session's first write. +- **Resolve**: `gh issue comment --body ""`, then `gh issue close `, then append a context pointer (gist + link) to the map's Decisions-so-far. diff --git a/docs/agents/triage-labels.md b/docs/agents/triage-labels.md new file mode 100644 index 00000000..b716855d --- /dev/null +++ b/docs/agents/triage-labels.md @@ -0,0 +1,15 @@ +# Triage Labels + +The skills speak in terms of five canonical triage roles. This file maps those roles to the actual label strings used in this repo's issue tracker. + +| Label in mattpocock/skills | Label in our tracker | Meaning | +| -------------------------- | -------------------- | ---------------------------------------- | +| `needs-triage` | `needs-triage` | Maintainer needs to evaluate this issue | +| `needs-info` | `needs-info` | Waiting on reporter for more information | +| `ready-for-agent` | `ready-for-agent` | Fully specified, ready for an AFK agent | +| `ready-for-human` | `ready-for-human` | Requires human implementation | +| `wontfix` | `wontfix` | Will not be actioned | + +When a skill mentions a role (e.g. "apply the AFK-ready triage label"), use the corresponding label string from this table. + +Edit the right-hand column to match whatever vocabulary you actually use.