jackzhang的个人空间 https://blog.eetop.cn/jack1 [收藏] [复制] [分享] [RSS]

空间首页 动态 记录 日志 相册 主题 分享 留言板 个人资料

日志

太夸张了!华为的这篇技术文档,竟然写了5217页……

热度 11已有 647 次阅读| 2024-1-8 12:12 |系统分类:芯片设计

文章来源于鲜枣课堂,作者小枣君

昨天是周末,小枣君按照惯例在公司加班。

突然,我看到粉丝群里,有小伙伴发了一条消息:

图片

一看到这条消息,我就来了劲——

什么鬼文档,竟然会有五千多页?我们平时的文档,最多也就几百页啊……

图片

为了眼见为实,我赶紧私信小伙伴,要来了这份文档。

发来的时候,文档大小果然非同一般,达到了124.9M:

图片

收了半天,总算下载下来。然后打开:

哦吼,果然,不多不少,一共5217页。

图片

这是一篇华为光传输设备OSN1800的硬件描述文档,主要介绍产品及单板的型号、外观、参数等信息

图片


看了一下目录。仅仅是目录,就有84页……

文档正文,一共有33章,小节不计其数……

图片


我又统计一下字数,一共大约181万汉字,或者366万个字符(含空格)

图片


这是啥概念?红楼梦才70万字,圣经(基督教旧约)150万字,大家可以对比一下。

我仔细浏览了一下这份文档。文档介绍了很多的单板、业务,以及光模块。型号确实非常繁杂,再加上内容基本上以表格和图片形式为主所以篇幅极为庞大。

部分页面展示:

图片

图片

图片


小枣君也当过好多年的文档经理,深知文档工作的重要性,以及把这项工作做好的难度。

这么说吧——这篇5217页的超级文档,真的是刷新了我的认知。

我个人有以下感受:

从产品的角度来看,通信技术经过这么多年的发展,确实变得非常复杂产品类型多,单板型号多,技术参数也多,想要逐一绍到位就需要海量的文档篇幅。

文档的篇幅越来越大,不仅给厂商的文档编写带来了巨大的挑战,也给用户带来了不小的压力。

文档团队的工作难度,会持续攀升。我们打开的是PDF版本,试想一下,使用文档开发工具进行编写的时候,肯定涉及到多人团队的协作。几千页的文档,能够做到不出错,很不容易。更别谈要保证文档的可读性。

华为的这篇文档,格式规范,内容全面。我挑了一部分细看,写得很有干货,堪称质量上乘。行业一贯都将华为文档视为标杆,确实有一定道理。

不过我还是觉得,当文档内容过于庞大的时候,也许可以通过分册的形式,进行分解。不然的话,对于客户阅读和使用,确实会带来很大的不便。

这还只是产品手册的其中一篇。整套文档,一般包括几十本手册。客户打开这种文档,估计都会有很大的心理压力。

大块头的文档,基本上是作为手册查询使用,如果真的是拿来一页一页学习,肯定会直接崩溃。5千多页的文档,如果打印出来,估计也能占满整个书架。


好啦,最后我再问问大家,你们遇到过比这篇更庞大的文档吗?大家觉得,行业里还有哪些公司的文档写的好?哪些写得烂?

欢迎在评论区留言!


图片



1

点赞

刚表态过的朋友 (1 人)

评论 (0 个评论)

facelist

您需要登录后才可以评论 登录 | 注册

  • 关注TA
  • 加好友
  • 联系TA
  • 0

    周排名
  • 0

    月排名
  • 0

    总排名
  • 8

    关注
  • 133

    粉丝
  • 565

    好友
  • 228

    获赞
  • 200

    评论
  • 49275

    访问数
关闭

站长推荐 上一条 /2 下一条

小黑屋| 关于我们| 联系我们| 在线咨询| 隐私声明| EETOP 创芯网
( 京ICP备:10050787号 京公网安备:11010502037710 )

GMT+8, 2024-4-24 01:00 , Processed in 0.014660 second(s), 7 queries , Gzip On, Redis On.

eetop公众号 创芯大讲堂 创芯人才网
返回顶部