- 目标:用业余时间产出高质量、小规模、可复用的教程(30–60 分钟到 2 小时的微教程,或 1–2 天的短教程)。
- 要求:可重复、可维护、易迭代、对读者友好(先行者/零起点两类)。
- 输出形式:Markdown 文档 + 代码仓(示例工程)+ 可选短视频/动图。
总体流程(一页版)
- Ideas草稿预备(作为文档系列的前言教程)
- 定位与大纲(准备好具体的目标读者,定位和大纲编写)
- 编写Draft草稿和初次设计
- 本地验证(自己跑一遍)
- 邀请Peers进行阅读验证
- 迭代修复
- 发布
- 收集反馈并计划下个迭代
目前计划的Workflow
(1–2 周,人均每晚 1hr + 周末 3–4hr)
- Day 0:确定主题与受众(30min)
- Day 1:写教程大纲 + 列出必要环境和成果(1hr)
- Day 3–6:撰写主体(分块完成,每晚 45–60min)
- Weekend:本地验证、补充示例、生成截图/动图(4hrs)
- Day 8:同伴测试与修订(1–2hrs)
- Day 10:发布并发通知(1hr)
撰写规范(质量控制)
预计的计划:
- 每篇给出明确时间长度(让读者决定是否有时间)
- 每个关键命令必须可复制粘贴并能运行(避免"概念性示例")
- 所有截图附带文字描述;所有图像都写
alt文本 - 给出可运行的最小示例(MVP)和可选扩展
- 明确列出环境版本(避免因版本导致报错)
- 代码注释要足够解释"为什么做这样",而非只实现
- 每篇至少包含 1 个练习与参考答案
测试与 CI(轻量级)
- 每个 tutorial repo 含
tests/quick_check.sh:自动化跑最小示例并返回 0/1 - CI(可选):在 GitHub Actions 上跑
quick_check,确保示例不会随时间失效 - PR 要求:运行
quick_check并通过,reviewer 复现至少一遍教程
版本/分支 & 协作(Git 工作流)
- 主分支:
main(发布稳定版) - 任务分支:
feat/tutorial-name或fix/tutorial-name - PR 模板(简短):
- 简述改动
- 如何复现(步骤)
- CI 状态(quick_check)
- 目标受众/冲突说明
发布渠道与格式(业余友好)
- 文字优先:GitHub Pages、Hexo/Hugo、简书、博客园
- 媒体辅助:短视频(3–8 分钟)、GIF(用于演示交互步骤)
- 同步渠道:Twitter/X、微博、微信公众号、LinkedIn
- 文章首发 + 程序仓库(示例代码)双管齐下
检查清单(发布前必须通过)
- [ ] 标题清晰并包含关键词
- [ ] TL;DR 与目标明确
- [ ] 环境/版本写明
- [ ] 所有命令已在干净环境验证
- [ ] 演示图片或 GIF 无缺失,且包含
alt - [ ] 至少 1 个练习与参考解答
- [ ] README 包含仓库快速运行步骤
- [ ]
tests/quick_check.sh可以本地一键跑通 - [ ] 有反馈渠道(issue/邮箱)
迭代范例(如何从 MVP 变成完整版)
MVP(发布后 1 周):
- 最小可运行示例 + 核心步骤 + 1 张演示图
V1(发布后 2–4 周):
- 补充 2-3 个练习、增加错误排查、增加视频或 GIF
V2(发布后 1–3 个月):
- 增加国际化(英文版)、兼容更多平台、CI 完整化