StrayMark - 推荐工作流
日常使用 StrayMark 的模式和节奏。
目录
初始设置之后
你已运行 straymark init . 并提交了结果。接下来呢?
- 用你的 AI 编码助手打开项目(Claude Code、Cursor、Gemini CLI 等)
- 助手会自动读取 StrayMark 指令(
CLAUDE.md、GEMINI.md等) - 从此刻起,助手会在正常工作流中在
.straymark/中创建文档 - 无需额外配置 — StrayMark 通过指令文件被动运行
日常开发
被动循环
- 正常使用你的 AI 助手工作——编写功能、修复 Bug、重构
- AI 根据治理规则在
.straymark/中创建文档:- AILOG 用于重大实现(>10 行变更)
- AIDEC 在多个方案间选择时
- ADR 用于架构决策
- ETH 当出现伦理考量时
- 审查标记为
review_required: true的文档 - 将文档与相应的代码变更一起提交
何时手动创建文档
在以下情况使用主动系统(Skills):
- AI 遗漏了对重大变更的记录
- 你(人类)做了一个应该记录的决策
- 你想创建 REQ、TES、TDE 或 INC 文档
- 你想检查文档合规状态
保持 StrayMark 更新
建议频率
- 每月或当你在 GitHub 上看到新版本时
- 查看发布页面了解变更日志
更新命令
| 目标 | 命令 |
|---|---|
| 同时更新 Framework 和 CLI | straymark update |
| 仅更新模板和治理文档 | straymark update-framework |
| 仅更新 CLI 二进制文件 | straymark update-cli |
Framework 和 CLI 有独立的版本 — 你可以单独更新其中一个。参见理解版本。
更新之后
- 检查指令文件和治理文档的变更
- 提交更新的文件:
git add .straymark/ && git commit -m "chore: update StrayMark framework" - 如果你自定义了 Framework 文件,检查是否有冲突
检查项目状态
CLI 状态
straymark status
显示:Framework 版本、CLI 版本、目录结构完整性和按类型统计的文档数据。用它来验证安装是否健康。
文档合规(Skill)
/straymark-status
/straymark-status Skill(在 Claude Code 和 Gemini CLI 中可用)分析:
- 哪些近期代码变更缺少对应的文档
- 文档与治理规则的合规情况
- 整体文档健康状态
使用 Skills(主动文档)
StrayMark 有两个文档系统:
| 系统 | 工作方式 | 何时使用 |
|---|---|---|
| 被动 | AI 通过指令文件自动记录 | 默认 — 自动发生 |
| 主动 | 用户调用 Skills 创建文档 | 当被动系统遗漏时,或用于人工决策 |
可用 Skills
| Skill | 用途 |
|---|---|
/straymark-status | 检查文档合规状态 |
/straymark-new | 创建任意类型的文档(建议最佳匹配) |
/straymark-ailog | 快速创建 AILOG |
/straymark-aidec | 快速创建 AIDEC |
/straymark-adr | 快速创建 ADR |
/straymark-audit-prompt CHARTER-XX (fw-4.8.0+,在 fw-4.9.0 中重构) | 在规范路径 .straymark/audits/<id>/audit-prompt.md 处生成统一的审计 prompt。封装 straymark charter audit --prepare。操作员随后打开 N 个审计员 CLI 并在每个中运行 /straymark-audit-execute — 无需复制/粘贴。 |
/straymark-audit-execute [CHARTER-XX] (fw-4.9.0+) | 在审计员 CLI 中运行(gemini-cli、claude-cli、copilot-cli、codex-cli)。从磁盘读取 prompt,使用 tool use 进行审计并引用 path:line,写入以审计员模型 ID 为键的 report。参数可选 — 自动发现此模型待处理的 prompts。 |
/straymark-audit-review CHARTER-XX (fw-4.8.0+,在 fw-4.9.0 中扩展) | audit-prompt 的对应。读取 N 个 reports,对 findings 与实际代码交叉验证,生成 review.md 六节合并分析(执行摘要 / 范围 / 按审计员评估 / 修复计划 P0-P4 / 丢弃 / 审计员评分),并将 external_audit: YAML 合并到遥测。 |
完整 Skill 详情参见 README。
Charter 审计检查点 (fw-4.8.0+)
在与人共同实现 Charter 时,Agent 会在一个特定时刻主动提议外部审计:当实现完成、drift 干净,且 charter close 尚未调用时。推荐基于 Charter 的风险面和复杂度给出 是/否(完整启发式见 .straymark/00-governance/AGENT-RULES.md §12)。
外部审计完全可选且永不强制。Charter 的声明性范围 + drift check + AILOG 纪律已为关闭提供了足够严格的支撑。审计在 Charter 触及安全面、引入新组件或 diff 中存在高复杂度函数时增加跨模型信号。如果你的情况下成本(2-3 个 LLM 审计员)与价值不匹配,可以自由拒绝。
团队模式
PR 审查
- 检查重大代码变更是否包含
.straymark/中的对应文档 - 审查任何标记为
review_required: true的文档 - 验证 AILOG 是否准确描述了 AI 所做的工作
新成员入职
- 引导他们查看
.straymark/QUICK-REFERENCE.md快速了解概况 - 让他们阅读近期 ADR 以理解架构背景
- 展示近期功能的 AILOG,让他们了解文档在实践中如何运作
Sprint 回顾
- 回顾 Sprint 中的 AILOG 和 AIDEC,了解 AI 贡献模式
- 识别应该记录但未记录的决策
- 检查 TDE 文档了解累积的技术债务
共享 AI 助手
当多个团队成员在同一项目中使用 AI 助手时:
- 每个助手会话产生各自的文档
- 元数据中的
agent字段标识每个文档由哪个助手创建 - 在 PR 审查中关注重叠或矛盾的 AIDEC
中国合规工作流 (opt-in)
如果项目在中国大陆运营或处理中国大陆用户的个人信息,启用 china 范围并按以下流程操作。
一次性设置
- 编辑
.straymark/config.yml并将china加入regional_scope:regional_scope:- global- eu # 如同时受 EU 约束- china - 运行
straymark compliance --region china查看基线(在创建相应文档前所有检查都会失败)。 - 阅读
.straymark/00-governance/下安装的指南:CHINA-REGULATORY-FRAMEWORK.md— 概览与覆盖矩阵TC260-IMPLEMENTATION-GUIDE.md— 五级风险分级PIPL-PIPIA-GUIDE.md— 何时需要 PIPIA 及其内容CAC-FILING-GUIDE.md— 单一 vs 双重备案、状态生命周期GB-45438-LABELING-GUIDE.md— 显式 + 隐式标识设计
添加生成式 AI 模型时
需一并创建并通过 related: 互相关联的文档集:
| 文档 | 用途 | 何时必需 |
|---|---|---|
MCARD | 含 cac_filing_required、gb45438_applicable、tc260_risk_level 的模型卡 | 范围内模型始终需要 |
TC260RA | 风险分级(场景 × 智能 × 规模 → 5 级) | 始终 |
AILABEL | 依据 GB 45438 的显式 + 隐式标识 | 模型生成内容时 |
CACFILE | 算法备案记录 | cac_filing_required: true 时 |
PIPIA | 个人信息影响评估(第55-56条) | 处理个人信息时 |
SBOM | 训练数据清单 + GB/T 45652 合规 | 始终 |
straymark compliance --region china 确认套件完整。
发生事件时
INC 模板包含 CSL 2026 Incident Reporting 部分。设置:
csl_severity_level: relatively_major # 或 particularly_serious | major | general
csl_report_deadline_hours: 4 # particularly_serious 为 1,relatively_major 为 4
straymark validate 强制严重程度-时限一致性(CROSS-008、CROSS-009)。major+ 事件须在 30 天内关闭(状态 accepted)以使 CSL-003 检查通过。
跨境数据传输
当过程涉及将个人信息传输至中国大陆境外时,在 PIPIA 上设置 pipl_cross_border_transfer: true,并在 Cross-Border Transfer Analysis 部分记录所选机制(CAC 安全评估 / 认证 / 标准合同)。CROSS-011 在未记录任何机制时发出警告。
日常合规检查
# 在合并涉及 AI 服务的功能分支之前
straymark validate # 跨规则,包括 CROSS-004..011
straymark compliance --region china # 各框架得分
理解版本
StrayMark 为两个组件使用独立版本管理:
| 组件 | 标签前缀 | 包含内容 | 更新方式 |
|---|---|---|---|
| Framework | fw- | 模板、治理文档、指令、脚本 | straymark update-framework |
| CLI | cli- | straymark 二进制文件 | straymark update-cli |
为什么使用独立版本?
- Framework 变更(新模板、更新的规则)更加频繁
- CLI 变更(新命令、Bug 修复)遵循不同的节奏
- 你可以更新治理文档而不需要新的 CLI 二进制文件
检查你的版本
straymark about # 快速版本检查
straymark status # 完整的健康报告,包含版本信息
详细的 CLI 信息参见 CLI 参考手册。