Skip to content

教程(Tutorials)

本目录定位:学习导向。带读者从零做出一个可运行的成果。

写作要求

  • 开头写明「你将做出什么 / 需要多久 / 前置条件清单」
  • 每一步:先说做什么和为什么 → 命令 → 预期输出 → 常见坑
  • 所有命令必须在干净环境实测通过
  • 结尾:回顾成果 + 「下一步」链接

判断标准:如果一篇文档没有「跟着做完能得到一个跑起来的东西」,它就不属于这里——任务型去 guides/,查参数去 reference/,讲原理去 explanation/

现有教程

教程时长读者
本地跑通后端15 分钟新加入的后端工程师
私有化部署(待补)30 分钟运维 / 部署客户
用 SDK 发出第一条消息(待补,写在 imboy-sdk-js 仓)15 分钟外部集成者

模板:见 documentation-system/templates/tutorial-template.md

IMBoy — 企业私有化即时通讯平台