外观
文档写作模板
新写一篇「问题解决」文档时,复制下面的模板到新文件,替换各节内容。保持统一格式,员工才能快速定位信息。
文件放哪里
- 通用问题放
docs/guide/faq/ - 模块问题放对应模块目录(如
docs/guide/purchase/) - 文件名用英文小写加连字符,如
billing-tax-rate-error.md - 侧边栏在构建时自动收录各模块目录下的文档(标题读取 frontmatter 的
title),新文档无需登记;也可直接用 Pages CMS 后台发文档,全程免操作
模板正文
markdown
---
title: 一句话说清问题(会显示在浏览器标签页和搜索结果里)
---
# 问题标题(建议以疑问句描述现象)
## 问题现象
描述用户看到的现象,越具体越好:什么页面、什么操作、出现什么提示。
如有多于一种情况,分条列出。
## 影响范围
哪些模块 / 哪些角色会遇到。如果只是个别数据问题,写明如何判断自己是否受影响。
## 原因分析
简述为什么会发生。帮助用户理解,避免下次再犯。
## 解决步骤
1. 第一步(附截图:截图放 docs/public/images/ 下,文件名与文档同名加序号)
2. 第二步
3. 第三步
::: warning 注意
涉及删除、反审核、修改历史数据等敏感操作,务必在这里单独警示。
:::
## 视频演示(可选)
<VideoPlayer src="文件名.mp4" title="XXX 操作演示" />
## 注意事项
- 操作后需要重新登录 / 重新打印等后续动作
- 数据依赖关系
## 相关问题
- [相关文档标题](./相关文档.md)常用语法速查
| 效果 | 写法 |
|---|---|
| 提示框 | ::: info / tip / warning / danger + 内容 + ::: |
| 截图 |  |
| 视频 | <VideoPlayer src="文件名.mp4" title="说明" /> |
| 按键 | <kbd>Ctrl</kbd> + <kbd>K</kbd> |
| 表格 | 标准 Markdown 表格 |
视频制作要求
- 单个视频不超过 25MB(网站硬性限制),建议控制在 20MB 以内
- 分辨率 1280×720(720p)即可看清操作;上传前用压缩命令瘦身(见项目 README)
- 时长建议 1~3 分钟,只演示关键步骤,配字幕或语音说明
- 命名用英文小写加连字符,如
goods-receipt-demo.mp4,放入docs/public/videos/
写完文档后,提交到 Git 仓库,约 1~2 分钟后网站自动更新。