贡献文档
最后更新于
这有帮助吗?
文档贡献包括修正错误路径、补充新功能教程、改善截图与示例、调整目录和翻译。目标不是“写得更多”,而是让读者按页面步骤能够完成任务。

已有 GitBook 编辑权限:在对应语言空间创建 Change Request;
没有编辑权限:在 Cherry Studio 打开【设置】→【关于我们】→【反馈】,说明页面地址、问题和建议内容;
文档问题与代码变更相关:在代码 PR 中勾选文档项并附上对应 Change Request 或说明无需更新。
操作路径
使用界面可见名称,例如【工作】→【添加智能体】
术语
首次出现时解释中文含义和作用
参数
区分产品默认值与建议起点,说明作用和风险
案例
使用具体角色、目标、输入和结果
截图
来自真实界面,有替代文本和编号说明
链接
指向当前页面或官方来源,提交前逐一打开
不要为了“看起来完整”而伪造成功结果。需要外部 API Key、付费服务或真实账号的功能,可以展示配置入口和前置条件,但不能编造连接成功、消息送达或模型输出。
截取应用内容区,不依赖某个系统的窗口装饰;
图片中的编号与正文说明一一对应;
一张图只承担一个主要任务,避免满屏标注;
同一页面保留关键步骤,不为每一次普通点击截图;
上传后在 Preview 中确认图片实际显示,不只是文件名或占位文本。
请找一位没有参与编写的人,只看教程完成一次操作。记录他在哪一步停下、哪个名词不理解、哪张图没有帮助,然后再改。文档通过语法检查,并不等于读者能照着完成任务。
一页教程最理想的结果是:读者知道什么时候用、从哪里进入、每一步会看到什么、失败后先检查哪里,以及完成后怎样确认结果。
没有旧入口、旧名称或过时功能;
没有写死不稳定的模型排行、价格和“最佳配置”;
没有版本号、验证日期或内部实现路径打断阅读;
界面名称统一使用【】;
文本读起来像产品编辑写给用户,不像生成报告;
每个步骤都能从当前界面找到对应入口;
图片、链接和 GitBook 原生内容块在 Preview 中正常渲染。
最后更新于
这有帮助吗?
这有帮助吗?