规则
As Albert Einstein puts it, “If you can’t explain it simply, you don’t understand it well enough.”
杨建国老师在《你好，放大器》中写到： 让人魂牵梦绕的东西， 都具备三个特点：有难度、能实现、你喜欢。下棋、足球、打游戏……追你心仪的对象， 但凡你能说得出来的，基本都如此。趁着年轻，为自己找个兴趣所在吧，最好，它还能养家糊口。
Jealy编辑在《开关电源基础知识》中写到： 作为电源行业的技术编辑，每天编写及整理出一篇篇技术文章便是我们工作的乐趣与重心。 在常人眼里，编辑工作似乎既繁琐又枯燥无味。但是身为编辑的我却可以深刻地体会到：虽然工作非常辛苦，但却异常幸福。因为这是一个可以不停地思考、不停地接触新知识、不停地读书、不停地将灵感转化为现实的工作；同时，把自己编辑过程中的点滴努力都体现在文章中，留下一个个实实在在的印记。
1 如何写好技术文档？
本公司技术文档力求实事求是，深入浅出，言简意赅，并借鉴较多窃以为扎实优秀的规则。以下部分参考和引用自：杨建国老师《你好，放大器》的6.5 撰写漂亮的报告
对一个人的评价，分为几个层面。第一是形象，第二是举止谈吐，第三是思想和内涵。层面越高的，越具有持久杀伤力。 对一个技术作品，其评价也会分为几个层面，第一是直观（板子是否漂亮），第二是上电表现（ 看数据说话），第三是文字（就是我们的技术文档）。文档占据第三层面，其重要性不言而喻。
1.1 态度
以下几点请牢记，牢记，再牢记。没有这些态度，即便文字天花乱坠，也是浮云流水。
第一，写出来的都是真的：绝不说假话。这包括两个方面：不能把 A 说成 B；不能有意挑选对你有利的，而回避不利的。
第二，存在的实验都是可重复的：科学实验有一个至关重要的原则，就是可重复。所谓的可重复，是指任何时候，任何人按照你所描述的场景，可以再现已经出现的结果。要做到这一点，第一你得说真话，第二你得描述清楚场景。
第三，完整表达了意思。每次、不同人读完，得到的信息是相同的：如果出现歧义，就修改吧。
1.2 内容
本文档系统采用markdown书写，js+CSS渲染；markdown文档(扩展名为.md)请勿标注字体字号等格式信息，尽量不要嵌入html标签等元素；
图表
1）优先采用图表（或嵌入关键词）而非纯文字，动态原理优先采用动画或视频Gif图而非静图，静图优先采用SVG矢量图，复杂原理优先直观定性地描述而非一上来就是数学计算；
2）图题是一张图的题目，表题是一张表的题目，应言简意赅；最好给每张图都标注图题，每个表格都标注表题，不要使用“下图，下表”等；
3）图题和表题应处于图的下方中间位置，图和表格在视觉上应低于正文中文字出现位置。当正文中出现如图 3-8 所示时，读者习惯性会向下找图 3-8。数字——阿拉伯还是汉字？文中出现的数字，到底使用汉字还是阿拉伯数字，是有规则的。
1）当这个数字具有明确的数字含义，或者说可以将此数应用于公式中时，一定要使用阿拉伯数字。比如，“3 斤白糖分给 2 个人”，就不能写为“三斤白糖分给两个人”；
2）当数字不具备明确的数字含义时，应该用汉字。比如四轮驱动，三角形，七上八下、四喜丸子、二阶滤波器等；
3）特殊用法，遵循习惯。比如五四运动， 1998 年 7 月。撰写禁忌
1）使用夸张的文字和描述。“感谢我的导师×××，他是我见过的最优秀的教师，是一代教师的楷模，是改革的中坚力量”；“本作品颠覆了传统的设计理念，用×××实现了××××，具有划时代的意义”；
2）使用诗歌、成语。“无独有偶，我们也采用了××××”；“山重水复疑无路，柳暗花明又一村，经过几天的奋战，我们终于××××”；
3）尽量少使用“我们，我”等，而使用“本文，本作品”等。语气禁忌
1）含糊或者不真实
科技文章用文字代替实际演示，就必须保证文章的可信度。当读者发现这个文章不可信时，你写什么都是无用的。因此，真实是科技文章的第一要素。 要做到真实，或者说让读者感到可信，第一条就是不说假话。只有自己内心感觉自己说的一切都是真实的，才能保证文章的真实性。 除了内心真实，在表现上也得注意一些技巧，就是不要写含糊的文字，以免引起别人的怀疑。
比如设计指标是 10kHz，你实现了 35kHz，如果你在文章中说：“本作品实测结果表明，上限截止频率远远高于指标要求。”就很容易让人怀疑。较好的表达是：“设计要求为10kHz，本作品实测为 35kHz，高于指标要求。” 在作品中增加实物照片、数据原始记录，都有助于增加可信度。
2）不平和
所谓的平和，就是作品报告似乎是第三者在描述，要使得文字中的气氛不被获得的成果所感染。“此前的男子 100 米世界记录是博尔特在 2008 年奥运会上创造的，成绩为9”62。在本届世锦赛上，我校运动员×××以 3”54 的成绩打破了这个记录。”就属于较为平和的语气。它陈述了“事实”，但是不渲染。
1.2 格式
注意区分中英文标点符号
注意段落划分，务求条理清晰
2 文档大纲
2.1 概述(Overview)
描述(Description): 必需
特性(Feature): 必需
应用(Application): 必需
外观图+尺寸图+接线图: 包含主要器件和接口的布局，整体和关键部分尺寸信息，典型应用的接线
选型表(Select Guide): 多种型号时必需
2.2 数据(Data)
数据表(DataSheet): 必需
数据图(DataChart): 可选
2.3 功能(Function)
功能框图(Function Block Diagram): 必需
功能描述(Function Description): 必需，包含整体工作原理，工作模式，关键部分
寄存器(Register): 可选
2.4 应用(Application)
应用要点(Application Information): 包含计算/设计、安装/接线/配置、操作、维护/校准/保养等
典型应用(Typical Application)
故障排查