[2021]文档整理小结

发表于 分类于
本文字数： 469 阅读时长 ≈ 1 分钟

距离上次系统性的整理文档快过去一年时间了。这一段时间以来，增加了很多新的内容，感脚之前的架构已经不能很好的匹配当前的知识储备，对于文章的保存和搜索也出现了越来越大的困难。从2/3月份开始，断断续续花费了近2个月的时间重新进行思考和整理，实现了一个相对而言更加合理、能够满足目前需求的架构

整体架构

将文档大体分为两部分进行管理：

  1. 发布到自建博客网站上
  2. 发布到readthedocs网站上

通常情况下，优先将文档发布到自建博客网站上；如果随着文档的积累，能够结合不同文档实现某一领域解决方案，那就整理成文档工程，发布到readthedocs网站上

具体细节

对于发布到自建博客网站的文章，使用类别和标签进行管理。简单的说，就是每篇文章指定一个类别，表明该文章所属领域（属于is a关系）；同时每篇文章指定多个标签，表明其涉及内容（属于is a关系）

对于文档工程，结合Mkdocs+Github+Readthedocs进行部署。按照其解决的问题进行文档保存，可通过实现语法、操作技能和常见问题解答等类别分别进行整理

具体实现