问HN:什么是优秀的数据表?

4作者: RetroTechie7 个月前原帖
我最近浏览了一些与RISC-V相关的系统级芯片(SoC)数据手册。在我的职业生涯中,我见过成千上万的数据手册(包括ROM、RAM、离散逻辑、外设、运算放大器、电压调节器等)。有些手册缺乏一些重要信息,比如热设计功耗(TDP)、BGA封装上的球数等。有一份(JH7100)提到了参考的标准,真不错!还有一份:拼写错误很多(中文可能是通过谷歌翻译翻译的?)。再有一份:某些数值被声明,但缺少单位。还有一份:大小写混乱,驼峰命名法相比之下显得温和(不过这似乎很常见)。另外,最好附上一个常用缩略语的简单词典,并不是所有读者都是专家! 老实说,漂亮的表格、框图等确实很重要。它们使数据手册更易于阅读,没错,“一图胜千言”在某种程度上是正确的。 总之,在您看来,什么样的数据手册才算好?应该(或不应该)包含哪些内容?在撰写时有哪些注意事项和禁忌?在这个背景下,什么是“附加价值”?
查看原文
I&#x27;ve been browsing a few (RISC-V related) System-on-Chip datasheets. Have seen 1000s of datasheets (ROM&#x2F;RAM&#x2F;discrete logic&#x2F;peripherals, opamps, voltage regulators, etc etc) in my life. Some lacking essential info like Thermal Design Power (TDP), # of balls on the BGA package, etc. One (JH7100) including mention of the standards that were referenced. Nice! Another: lots of spelling errors (Chinese pulled through Google Translate?). Yet another: some value declared, but missing the unit. Yet another: upper&#x2F;lower case all over the place, CamelCase looking tame in comparison (this seems commonplace though). Also: a simple dictionary of abreviations used. Not all readers are experts!<p>To be honest: nice looking tables, block diagrams etc <i>do</i> matter. They make a datasheet more readable, and yes &quot;1 picture says more than 1000 words&quot; <i>is</i> true to some degree.<p>In short: in your opinion, what makes a good datasheet? What <i>should</i> (or should not) be included? What are do&#x27;s &amp; don&#x27;ts when writing one? What&#x27;s &#x27;added value&#x27; in this context?