「K4NZ」- 文档分类(博客规范)

更新日期:2020年03月19日
@IGNORECHANGE @SPEC

(分类)根目录索引

类型 等级 描述
00.INDEX   最近更新的文章,这是笔记的一个简单介绍页面。(用Python脚本生成)
# 基础知识 # 01-05 底层技术及基本知识。比如网络知识,编程语言,操作系统,硬件知识等等。
# 技术应用 #   基础技术的应用。比如容器技术,爬虫技术,数据库技术,软件工程等等。
# 管理方法 #   软件工程是一个例子。它用到了某些技术,但是更多的是一些管理方法相关的内容。
z.All Uncategorized Articles...   未分类的杂记

该分类的划分依照是「我个人对各种技术关注度」,并不是标准,每个人都可以自己的分类喜好。与软件应用相比,我更喜欢计算机技术,更喜欢研究硬件、操作系统、网络、算法等等基础技术。应用技术,比如软件开发、监控、数据库、容器等等,变化块、投入产出比相对较低、依赖于基础技术,也只是为了解决问题才学习。当然,每种技术,不管是发明它,还是学习它,都是为了解决某个问题。

(分类)专题目录索引

# Category Name(Introduction) - 标题页面包含了最开始的简单介绍及基本原理组件,用于辅助安装部署。

# 1.Concepts and Architecture
- 使用方法及基础概念;
# 2.Installation
# 3.Administration and Configuration
- 完成某些特定操作;
- 服务的管理与配置(与服务相关);
# 4.Security
# 5.Performance
# 6.Logging and Monitoring
# 7.Cluster and High availability
# 8.Backup and Recovery
# x.Miscellanies
# 0.Books and Forums
# z.Error List
! 由于管理不善而引发的错误,属于「3.Administration and Configuration」部分。

目前按照此目录结构整理某技术笔记。

(分类)笔记全文结构

叁大原则:一、主题明确,二、内容精准,三、结构清晰

三、结构清晰

章节标题 作用
# 文章标题 (重要)需要指明类别;并用单句概述文章内容;
内容简介/问题描述 对文章内容简述;文章背景、起因;
解决办法/文章正文 (重要)问题的解决办法。章节及操作步骤一定要在标题中体现。
附加说明/注意事项 附加说明,或者注意事项。
相关链接 在完成本文的过程中所相关的文章。
参考文献 参考内容,对引用内容的标注。

文章内容类型

鉴于官方文档及RFC等等文章己经非常完善,我们能够编写的文章总共以下几类:

原理概述类笔记

内容:讲述背后技术原理
目的:(1)简述官方内容;(2)知识汇总,形成体系;(3)知识梳理,深入细节;
风格:(1)省略描述语言;(2)记录关键点,配合少许说明;

操作指导类笔记

内容:指导解决特定问题,讲述某些操作流程。
目的:(1)指导解决某类问题
风格:(2)
这是对官方内容梳理,记录我们常用操作,当然也包含日常杂记。

功能实现类笔记

内容:为实现功能写文章,记录创造、想法、发现。使用知识进行发明创造,也是激动人心的地方,因为你总能发现某些诡异的玩法。

# 在笔记中要避免问题

切忌翻译文档
(1)直译官方文档已经背离写作初衷。
(2)翻译文档是为了与他人分享,而我们写作的目的并不是为了分享官方文档。
(3)另外……翻译文档还不如劝人学习外语。

切忌事无巨细
(1)再详细也不会超过官方文档。
(2)对于操作说明(说明书)性文章,核心在于“章节标题”。“章节标题”需要体现操作目的,而“章节内容”只需要概述操作过程。
(3)在内容中,切忌列举达到某以目的的多种方法。

文章标签

用于标记文章,对文章内容补充说明。

标签名 标签作用 文章价值
IGNORECHANGE 忽略更新 内容混乱,属于技术杂记、或者某主题主页。(不具备参考价值)
UNRESOLVED 问题未解决 具有解决某些问题的参考价值,但是存在很长严重未解决问题
FINISHED 已完成 文章内容以完善,可知道解决某一问题
SCRIPT 脚本 文章内容为常用脚本,用于解决某些问题。
TERM 术语 文章内容属于术语解释

ToC

(分类)根目录索引

(分类)专题目录索引

(分类)笔记全文结构

三、结构清晰

文章内容类型

原理概述类笔记

操作指导类笔记

功能实现类笔记

# 在笔记中要避免问题

文章标签