Skip to content

技术内容写作系统

writingknowledge-baseworkflow

为什么需要系统

技术内容很容易散落在聊天记录、临时文件、仓库 README 和浏览器收藏夹里。短期看只是不好找,长期看会变成重复学习和重复排错。

我希望把内容分成三层:

  1. Notes:记录可复用的知识点、命令、排错路径。
  2. Blog:讲完整问题,包含背景、方案、取舍和结果。
  3. Projects:把项目的目标、实现和仓库链接放在一起。

写作顺序

推荐顺序不是先写长文,而是先保留原始材料:

  1. 记录问题现场:环境、版本、报错、链接。
  2. 写下最终解决步骤。
  3. 补充为什么这样做。
  4. 如果这个问题有复用价值,再整理成博客。
  5. 如果来自项目实践,再回填到 Projects。

单篇笔记模板

md
# 标题

## 场景

这篇笔记解决什么问题?

## 环境

- OS:
- 版本:
- 依赖:

## 步骤

1. ...
2. ...

## 坑点

- 现象:
- 原因:
- 解决:

## 参考

- ...

维护原则

  • 写具体版本,不写“最新版”。
  • 命令和配置尽量可复制。
  • 过时内容不要硬删,先标注状态。
  • 同一个主题先集中,再拆分。

Built with VitePress. Written as a long-term notebook.