【实用】关于产品文档阅读
哈喽,大家好,我又来了。见字如面,每篇锤炼!我经常在微信群、QQ群等中看到一些技术询问行为。诚然,这种社交渠道群聊方式在获取帮助和交流思考激发灵感方面,有很大的正向促进作用。不过,我也从这种现象中察觉到挺多小伙伴们并不重视对产品文档的检索查阅,或者说并不知道怎么从产品文档中获取帮助。今晚,我稍加梳理总结,分享于你!
一手材料放手边
早前Python网络自动化探讨中,我几乎每介绍一个第三方轮子,都会直接分享我探寻官网的过程与思考。同样,日常当我们开始参与某些具体网络设备的运维时,相应设备硬件型号,对应软件版本的文档手册理应优先被我们拿到手中。官网材料,产品手册,这些属于一手材料,是说明书,可以说是最权威的,其它各类资料均大体由这些出发。目前就我接触过的,只要是正规厂商的设备,都有较为完整的产品文档体系。各大厂商对自己的产品文档梳理工作也极为重视。
当然,这种“说明书”式的产品文档,其文本量可以用“惊人”来形容,是很难直接当教材通读的。因此,市面上的书籍、文章(比如我写的)可以从实际使用者的角度辅助快速切入,并提供一些实际示例和使用感悟做参考。在这一点上,教程与文档,其实并不矛盾,而相辅相成。而当要深入钻研谋求进阶,或遇到问题要寻找依据时,我们还是得回归一手资料。
简而言之,一台设备拿到手,对应的产品文档也拿到手,其它后面再说。
产品文档巧查阅
产品文档往往把所有相关的细枝末节等内容都一并纳入,进行编排。我们拿到产品文档,一开始想通读的话,可能会陷入死胡同。教材和书籍则更倾向于沿着一条主线,把相关知识点进行编织。这可能就是两者的差别吧。于是我推荐组合使用,配合着来。
与通读学习相对应的是把产品文档当成字典来检索查阅,或许这种方式更为可行。不同厂商设备会有不同的产品文档阅读器,文档信息结构编排方式等,但是大体对不同主题,不同关键字会做一些索引。我们可以通过关键词搜索查阅的方式,来定位到我们要的相关内容,包括技术原理(可学习),命令配置(可练习)。
我日常以华为数通设备运维为主,下面分享一下华为产品文档检索查阅的一些实践体验。
华为 ICS 初体验
作为一名老网工,多年来华为HedEx Lite(“海带丝”) 用得好好的。据说“海带丝”要退出历史舞台了,于是我最近切换成新的ICS Lite。浏览一下官方的介绍,大体上,ICS(Information Center Service,信息中心服务)是华为新一代信息服务。其文档后缀为hwics,在本机查阅ICS文档需要使用ICS Lite软件,同时兼容原HedEx Lite(“海带丝”)的HDX文档。相关的内容会跟你说这个ICS多牛多牛,但就文档阅读来说吧,关键是能找到有用信息即可,总体上说,使用感觉变化不大。
https://zhuanlan.zhihu.com/p/562036720



微信文章目录:https://zhuanlan.zhihu.com/p/570090654我知乎总目录:https://zhuanlan.zhihu.com/p/370526806
相关文章合集:
感谢阅读,欢迎关注点赞,转发分享!
2022年10月于广东汕头
夜雨聆风
