doc-user-guide

name	doc-user-guide
description	当用户需要写用户指南时使用;当需要满足用户对用户指南的要求时使用

doc-user-guide

作用

限定如何写用户指南

流程

• 先把已经写过的用户指南进行读取
• 然后询问用户本次要写哪些方面的用户指南
• 当用户需要存放FAQ相关指南时, 询问用户有哪些疑惑, 然后自己通过 当前代码文件 -> 当前文档 -> 历史git记录 的优先级顺序寻找答案之后记录

规则

• 用户指南应该简洁明了，易于理解
• 如果当前有waza-writeskill, 阅读书写规范
• 默认放在项目docs/user-guide下, 自带一个README.md用来索引, 存放一个表格, 记录所有当前目录下的文档, 一列文件名和路径, 一列简要注释
• 使用 00-<slug>.md 的格式进行命名; 一般00用来写quickstart, 指引用户
• 每个编号对应一个特定功能模块, 根据项目来自动识别
• 根据代码实现的功能写功能描述(不要繁杂,核心功能)
• 有展示核心配置示例, 和配置的表格(描述默认值和作用)
• 项目根 README 中引导用户查看(使用文件链接跳到docs/user-guide/README.md)
• 每个文档, 可以尝试使用本地配置进行示例, 向用户询问具体的配置; 调用 grilling 技能询问; 如果用户没有; 从代码中寻找路径
• 自己通过 当前代码文件 -> 当前文档 -> 历史git记录 的优先级顺序寻找答案之后如果还有不懂的; 才应该询问用户
• 特殊指南FAQ.md存放用户反馈的疑问