网络工程师要会写技术文档吗
技术圈有个流传很广的偏见：会干活就行，写文档是浪费时间，真正的高手都在敲命令，只有搞不定技术的人才去写材料。如果你信了这套说法，职业发展大概率会吃暗亏。这篇就聊聊技术文档这件事，为什么它是网络工程师绕不开的能力，以及怎么把它练出来。
先看现实里网络工程师要写多少东西。设备巡检报告、割接方案、故障复盘报告、网络拓扑说明、变更记录、项目验收文档、给甲方看的运维月报、给领导看的汇报材料。数一下就会发现，这行的"书面输出"频率其实很高，尤其在你往高级别走之后。初级工程师可能一周写一份巡检报告，到了技术负责人，方案和复盘就是日常。
为什么文档能力重要？三个原因。第一，网络是需要被解释的东西。你的网络设计得再好，甲方、领导、接班的同事看不懂，价值就打折扣。割接方案写得清楚，客户才敢让你在业务时间动网络；故障复盘写得明白，团队才能避免踩同一个坑。第二，文档是团队协作的载体。几个人维护一张大网，靠的不是心领神会，是变更记录和配置文档，没文档的网络，人员一流动就成黑盒，接手的人两眼一抹黑。第三，文档是你的职业资产。做过什么项目、解决过什么疑难故障，口头说会随风散，落在文档里才是履历。竞聘、跳槽、评职称，能拿出成体系技术文档的人，说服力完全不同。
网络工程师的文档分几种境界。第一种，应付型，为了交差写，模板复制、数据乱填，这种文档不如不写。第二种，记录型，把做了什么如实写下来，能用，但读的人还是要费劲。第三种，面向读者型，写之前想清楚这份文档给谁看、他要什么信息，方案文档让决策者能看懂风险和回退路径，复盘文档让没在场的人能还原过程，这是高手的状态。技术文档的本质不是记录技术，是和人沟通技术。
怎么练？给四个接地气的方法。第一，从结构化开始，任何文档先搭骨架：背景、目标、现状、方案、风险、回退，骨架有了，内容自然往里填。第二，把每次故障处理都写个小复盘，哪怕只有十行，故障现象、定位过程、根因、解决办法，坚持写一年，你的排障思维会脱胎换骨，因为写的过程逼你把模糊的直觉变成清晰的逻辑。第三，学工具，拓扑图软件用起来，图比文字的信息效率高十倍，一张准确的拓扑图顶三页描述。第四，找范本，公司里写得好的文档、网上优秀的方案案例，拆解人家的结构怎么搭的，拿来主义起步最快。
还有一层要说透：文档能力和认证考试的论述是一脉相承的。H3CIE的实验考试，排障过程要记录清楚，让评卷人看明白你的思路；H3CIE-Cloud的面试环节，项目汇报的表达背后也是结构化输出的功力。平时不练文档的人，这些环节天然吃亏。像润天教育这类新华三授权培训中心的实验课，讲师都会要求学员把排障过程整理成规范的记录，这个习惯养成了，考试和职场两头受益。
最后回应一下开头的偏见。会干活是技术能力，会写文档是把技术能力放大给别人看见的能力，两者不冲突，后者是前者的杠杆。你见过哪个技术总监是靠闷头敲命令当上去的？往上走的每一步，都是把你懂的东西，讲给更多人听懂的过程。文档，就是这个过程的日常训练。
