一篇文档的最小结构
- 背景：遇到了什么问题，适用什么环境。
- 步骤：按照执行顺序给出命令和配置。
- 验证：如何判断已经成功。
- 边界：哪些情况不适用，下一步可以看什么。
示例要完整
命令旁边写一句它在做什么；配置示例带上关键上下文；输出结果只保留能帮助判断的部分。文档不是命令堆，而是一次可复现的解决过程。
保持可维护
为文章添加更新时间和适用版本。环境变化后，优先更新验证步骤。若方案被替代，保留迁移说明，而不是让旧文章悄悄失效。
写给未来自己的 Markdown 文档
一份短小的文档写作约定：从问题出发，给出可执行步骤，并明确验证结果。
— 本文完 —
← 返回全部文档把解决过的问题，变成可以复用的经验。