zoukankan      html  css  js  c++  java
  • 数据手册的设计

    今天在网上瞎逛,到了宏晶官网,就被首页上的图片怔住了。怀着复杂的心情,我下载了STC单片机的数据手册。讲真,这是我第一次接触这种风格的datasheet。

    Datasheet的讲究还挺多的,我决定写这篇文章。

    Datasheet就是数据手册,是要讲数据的。下图是STC单片机的中文版datasheet,在附录部分有一些与产品无关的内容。

    附录,应该放一些不宜放在正文,而又与主题又密切关系的内容,比如errata、revision history等。也可以放在正文最后。下图来自Microchip的ATmega324PA datasheet。

    下图同样出自STC单片机datasheet,它除了有无关内容以外,排版也很糟糕,而且有大量的纯色文字,这些内容对打印版是不友好的。

    需要注意的内容,应该用脚注的形式写在图片下方或页面底部。图片来自TI的NE555 datasheet。

    下图同样出自ATmega324PA的datasheet。表格背景为浅色,相邻行之间采用不同背景色,不会看歪,对用户友好。

    datasheet有data,这些data一定要准确。下图是一个LCD厂家的datasheet,红色字是我标注的。实际上我在用真机调试之前就已经发现了这个错误,一个原因是其他同类产品中此位为1,另一个原因是huffman编码的知识告诉我这里必须是1,否则会与其他指令产生二义。

    下图来自另一国内厂家的LCD datasheet,每个单词我都看得懂,但是连在一起就不知道是什么意思。机翻还不是最大的问题,存贮器直接译为CunZhuQi我是真的很服气,要不是会中文和拼音,谁能看懂这种词?

    下图是TI的SN74HC595的中文datasheet的目录,问题在于翻译不完全。

    在翻译的问题上,STC做得还是不错的。

    总之,一份优秀的datasheet,应该做到:

    内容准确、充实,把产品描述清楚;

    详略得当,把用户的注意力转移到重点上去;

    没有无关内容,写清楚产品的使用就够了;

    顺序安排合理,可以由浅入深,或者由底层到封装;

    如果有翻译,要正确且完整,就算机翻,也要找个靠谱的;

    对于需要注意的地方,可以用脚注,不要直接写在旁边;

    各处字体、排版、格式要统一,不能乱;

    配色合理,不影响打印,能改善阅读体验更好;

    ……

    最后以一个优秀的设计作为本篇文章的结尾。措辞不太正式,但反而更容易理解,同时给人以亲切感;左上角logo大小适中,底部有官网与邮箱的联系方式;文字行距适中,格式整齐;时序图清晰直观,看着就能直接写程序,是真正的“快速使用指南”。

    这样的datasheet真是赏心悦目。

  • 相关阅读:
    洛谷P3275 [SCOI2011]糖果
    2018年12月30&31日
    洛谷P4114 Qtree1
    洛谷P4116 Qtree3
    洛谷P4315 月下“毛景树”
    洛谷P1505 [国家集训队]旅游
    洛谷P2253 好一个一中腰鼓!
    CF616D Longest k-Good Segment
    洛谷P3979 遥远的国度
    洛谷P2486 [SDOI2011]染色
  • 原文地址:https://www.cnblogs.com/jerry-fuyi/p/11302524.html
Copyright © 2011-2022 走看看