cs-guide

cs-guide

代码解决问题，文档让别人能用它解决问题。spec 记录"做了什么、为什么这么做"，但下游开发者和终端用户不需要、也不应该读 spec——他们需要面向自己角色的、可发布的指南。guidedoc 就是从 spec 和代码出发写成读者真正能用的指南。

两条轨道

轨道选择从"谁读"出发——同一个 feature 经常需要两份：API 变化进 dev-guide，对应的用户操作进 user-guide。

路径 docs/dev/ 和 docs/user/ 是默认约定，项目已有自己的 docs 结构就以项目为准——开始前先确认。

触发时机

主动推送一句话即可，用户说"不用"就别再提——多次推会让用户觉得 AI 在加戏。

涉及路径

guidedoc 产物不在 codestable/ 下——指南是面向外部读者的可发布产物，和 spec 工件分开。

• dev-guide → docs/dev/{slug}.md
• user-guide → docs/user/{slug}.md

文件命名 {slug}.md（英文小写连字符，无日期前缀）——指南持续更新按主题管理。

检索：

python codestable/tools/search-yaml.py --dir docs/dev --filter doc_type=dev-guide --filter status=current
python codestable/tools/search-yaml.py --dir docs/user --filter doc_type=user-guide --filter component={feature-slug}

YAML frontmatter

---
doc_type: dev-guide | user-guide
slug: {英文连字符}
component: {关联模块名或 feature slug}
status: draft | current | outdated
summary: {一句话描述涵盖什么}
tags: []
last_reviewed: YYYY-MM-DD
---

status 三态：draft 待 review；current 当前有效；outdated 对应代码已变文档没跟上（保留原文，标记后推送更新）。

文档格式

dev-guide 正文结构

## 概述
一段话描述功能定位和适用场景。

## 前置依赖
集成此模块所需的环境、依赖或配置（如有）。

## 快速上手
最小可运行示例。代码优先文字辅助。

## 核心概念
（可选）理解接口 / API / 模块行为所需的关键术语和设计决定。

## 接口参考
主要 API / 配置选项 / 事件 / 钩子。表格或逐项列举。

## 常见场景
2-4 个实际使用场景代码示例，覆盖 happy path 和常见边界。

## 已知限制与注意事项
（可选）边界、性能考虑、已知 bug 绕过方式。

## 相关文档
关联的 user-guide、方案 doc、架构 doc 或外部参考。

user-guide 正文结构

## 功能简介
一段话描述功能是什么、解决什么问题。

## 前置条件
（可选）使用前的前提（账号权限、需先完成的操作）。

## 如何使用
步骤化操作。每步一行，关键操作配截图占位（`![描述](./assets/xxx.png)` 或注明"此处需截图"）。

## 常见问题
Q: ...
A: ...

## 相关功能
（可选）关联功能跳转链接或说明。

工作流步骤

1. 明确任务范围——轨道（dev / user / 都要）+ 覆盖范围（新写还是更新）+ 信息来源（方案 doc 已有吗？同 component 已有 guide？需要读哪些代码？）
2. 收集输入——读方案 doc（重点第 0 节术语、第 2 节接口契约、第 1 节用户可见行为）+ search-yaml.py 搜 docs/ 确认有无已有 guide。发现已有 guide 标 outdated → 任务定性为更新
3. 起草——按对应轨道结构起草，frontmatter status: draft。约束：只写面向目标读者的内容——不要把方案 doc 里"实现提示"或内部设计搬过来；术语与方案 doc 第 0 节一致；代码示例必须来自实际代码不虚构接口
4. 用户 review——展示草稿，逐节确认覆盖范围 / 描述准确性 / 是否有读者看不懂的地方
5. 落盘——用户放行后：写入路径；status: current + last_reviewed 当天；更新已有文档时小修直接改，大改（结构重组 / 读者定位调整）先把旧文档 status: outdated 留作参考再新写一份

与其他工作流的关系

容易踩的坑

• 把方案 doc 里"实现提示"原文搬进 dev-guide——那是内部 spec
• 没检查已有 guide 就新建——可能两份冲突
• 写完 status 还是 draft——落盘必须改 current
• 代码已更新相关 guide 还是 current——应标 outdated 并推送更新
• dev-guide 和 user-guide 内容高度重叠——其中一份定位有误
• 用 guide 存放 spec 信息（不变量 / 测试约束 / 根因分析）——这类内容属于 codestable/