欢迎来到汪汪队教程站
汪汪队教程站是一个面向实践的教程网站。第一版先解决三件事:
- 读者可以按分类阅读清晰的图文教程。
- 作者可以用 Markdown/MDX 写教程并提交 Pull Request。
- 维护者可以审核、预览并自动发布内容。
当前阶段:本站第一版使用 Docusaurus 生成静态页面,内容存放在 GitHub 仓库,部署目标是 Cloudflare Pages 免费版和
learn.zxcheng.org。
内容分类
| 分类 | 适合内容 |
|---|---|
| 入门指南 | 新读者、新作者需要先理解的基础说明 |
| 实战教程 | 从目标、准备、步骤到结果的完整操作记录 |
| 工具教程 | 截图、预览、部署、编辑器等工具流程 |
| 进阶专题 | 内容架构、站点维护、复杂协作流程 |
| 投稿指南 | 写作模板、PR 流程、审核清单 |
一篇好教程应该做到什么
好的教程不是简单记录“我做了什么”,而是让下一个人可以复现:
- 目标明确:读者知道最终会得到什么。
- 准备完整:版本、账号、工具和前置知识写清楚。
- 步骤可执行:每一步都有可检查的结果。
- 截图克制:截图帮助定位关键界面,不替代文字说明。
- 问题可排查:常见错误和解决方式放在最后。