这套文档覆盖什么
每一款产品在「产品文档」里都有自己的页面,内容固定包含五块: 它解决什么问题、怎么开始使用、关键功能怎么操作、 常见报错与原因、它做不到什么。
文档只写已经上线的能力。尚未发布的产品会明确标注「未上线」,并且只说明设计取向,不写功能承诺。 这是刻意的——与其读一份写得漂亮但对不上的说明书,不如读一份短但准确的。
三种查法
一、按产品找
十二款产品按分类排在顶栏,同一分类有多款时展开下拉;点哪一款就进哪一份文档。 进去以后,左侧只会列出这一款产品自己的章节——它解决什么问题、怎么开始、有哪些功能、 哪里会卡住、版本怎么变,不会混进别家的目录。
二、按关键词搜
按 Ctrl K(macOS 为 ⌘ K)随时唤起搜索,也可以在任意页面直接按 /。
搜索同时匹配产品名、页面标题、描述与同义词——比如搜「导出」能同时找到墨线、拾句和拾色,
搜「打不开」会落到常见问题。
输入后按 ↑ ↓ 选择结果,Enter 打开,Esc 关闭。不用离开键盘。
三、直接打开链接
所有文档都有稳定地址,形如 docs.qinghuali.com/products/产品标识.html。
可以收藏、可以发给同事,不会因为改版失效。
文档里的几个约定
| 标记 | 含义 |
|---|---|
| 已上线 | 功能可用,文档与线上版本一致 |
| 内测 | 可用但仍在调整,界面与行为可能变化 |
| 未上线 | 尚不可用,页面只说明设计取向 |
| 版本号 | 页面顶部的版本号对应文档描述的功能版本,不等于最新版 |
代码块右上角有复制按钮,点一下整段复制。带颜色的提示框分四种: 蓝底是补充说明,绿底是建议做法,赭底是会导致问题但可恢复的操作,红底是可能丢数据的操作——看到红色请先读完再动手。
找不到答案时
文档没写清的部分,通常有两种情况:一是你遇到了边缘场景,二是这里确实漏了。 两种情况都建议直接反馈,把产品名、版本号、报错原文、操作步骤一并给出,这四项齐了基本一次就能定位。
反馈入口:官网联系页, 或邮件 hi@qinghuali.com。 与产品或文档无关的商务合作请走官网的合作入口,不要发到文档反馈里——那条线我未必看得到。
文档站与主站共用同一套设计令牌与主题偏好,在任一站点切换浅色/深色,另一个站点会同步。