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

本文介绍了个人技术笔记的分类和结构调整方法,旨在提高知识管理效率。通过合理的分类和清晰的结构设计,帮助读者快速定位所需信息,同时涵盖笔记撰写的原则与技巧。

为什么调整分类?

因为我们希望能快速地找到所需要的笔记。

(分类)根目录索引

类型等级描述
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)指导解决某类问题
风格:(1)指向官方文档;(2)内容简单;
这是对官方内容梳理,记录我们常用操作,当然也包含日常杂记。

功能实现类

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

# 在笔记中要避免问题

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

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

相关文章

「MPLINUX.COM」- 01.SPECIFICATION
「K4NZ」- 我不知道的东西
「Industry Analysis」
「Testing」- 商户系统
「Linux」-文件对比工具
「SoftEther VPN」
「K4NZ」- TRASH(保留归档笔记)
「Growing Flowers」

内容概要:本文设计了一种基于PLC的全自动洗衣机控制系统内容概要:本文设计了一种,采用三菱FX基于PLC的全自动洗衣机控制系统,采用3U-32MT型PLC作为三菱FX3U核心控制器,替代传统继-32MT电器控制方式,提升了型PLC作为系统的稳定性与自动化核心控制器,替代水平。系统具备传统继电器控制方式高/低水,实现洗衣机工作位选择、柔和过程的自动化控制/标准洗衣模式切换。系统具备高、暂停加衣、低水位选择、手动脱水及和柔和、标准两种蜂鸣提示等功能洗衣模式,支持,通过GX Works2软件编写梯形图程序,实现进洗衣过程中暂停添加水、洗涤、排水衣物,并增加了手动脱水功能和、脱水等工序蜂鸣器提示的自动循环控制功能,提升了使用的,并引入MCGS组便捷性与灵活性态软件实现人机交互界面监控。控制系统通过GX。硬件设计包括 Works2软件进行主电路、PLC接梯形图编程线与关键元,完成了启动、进水器件选型,软件、正反转洗涤部分完成I/O分配、排水、脱、逻辑流程规划水等工序的逻辑及各功能模块梯设计,并实现了大形图编程。循环与小循环的嵌; 适合人群:自动化套控制流程。此外、电气工程及相关,还利用MCGS组态软件构建专业本科学生,具备PL了人机交互C基础知识和梯界面,实现对洗衣机形图编程能力的运行状态的监控与操作。整体设计涵盖了初级工程技术人员。硬件选型、; 使用场景及目标:I/O分配、电路接线、程序逻辑设计及组①掌握PLC在态监控等多个方面家电自动化控制中的应用方法;②学习,体现了PLC在工业自动化控制中的高效全自动洗衣机控制系统的性与可靠性。;软硬件设计流程 适合人群:电气;③实践工程、自动化及相关MCGS组态软件与PLC的专业的本科生、初级通信与联调工程技术人员以及从事;④完成PLC控制系统开发毕业设计或工业的学习者;具备控制类项目开发参考一定PLC基础知识。; 阅读和梯形图建议:建议结合三菱编程能力的人员GX Works2仿真更为适宜。; 使用场景及目标:①应用于环境与MCGS组态平台进行程序高校毕业设计或调试与运行验证课程项目,帮助学生掌握PLC控制系统的设计,重点关注I/O分配逻辑、梯形图与实现方法;②为工业自动化领域互锁机制及循环控制结构的设计中类似家电控制系统的开发提供参考方案;③思路,深入理解PL通过实际案例理解C在实际工程项目PLC在电机中的应用全过程。控制、时间循环、互锁保护、手动干预等方面的应用逻辑。; 阅读建议:建议结合三菱GX Works2编程软件和MCGS组态软件同步实践,重点理解梯形图程序中各环节的时序逻辑与互锁机制,关注I/O分配与硬件接线的对应关系,并尝试在仿真环境中调试程序以加深对全自动洗衣机控制流程的理解。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值