模板
需求
SRS文档
接口文档
设计
概要设计
详细设计
软件设计
移植设计
什么样的文档是好的文档：
一个装修需求的描述：
不好的设计文档实例：（平直的陈述）
房子南北走向，房子大门在东侧中间位置。门厅长约3米，宽2米，门厅左面是主卧室，右面是厨房。厨房3米宽，4米长，厨房门对着门厅，厨房的顶头还有一个北阳台，与厨房同宽，长1米。主卧室宽3米，长5米左右，房间门对着客厅。客厅与餐厅连为一体，共7米长，4米宽，与客厅相连有一南阳台，与客厅同宽，长1.5米。
餐厅的北面是卫生间，卫生间与厨房相对，中间由1米宽，3米长的过道隔开；卫生间门对着过道，南墙与厨房的南墙在一条直线上；卫生间为长方形，南墙长3米，另一边长2米。卫生间的北面是次卧，同宽，门朝着过道，次卧长4米。过道的北端是书房门，书房南北长4米，书房有一个一米见方的门厅，书房的西墙长4米，包括1米长的门厅长度，西墙把书房和次卧分隔开。门厅东墙北端90角折向东，长2米，把书房和厨房北阳台分隔开。
优化后的设计实例：（只是简单地进行了分段，阅读起来更有层次感更清晰。同时修正了“约”、“左右”等模糊的描述。）
1.房子南北走向，房子大门在东侧中间位置。
2.门厅长3米，宽2米，门厅左面是主卧室，右面是厨房。
3.厨房3米宽，4米长，厨房门对着门厅，厨房的顶头还有一个北阳台，与厨房同宽，长1米。
4.主卧室宽3米，长5米左右，房间门对着客厅。
5.客厅与餐厅连为一体，共7米长，4米宽，与客厅相连有一南阳台，与客厅同宽，长1.5米。
6.餐厅的北面是卫生间，卫生间与厨房相对，中间由1米宽，3米长的过道隔开；卫生间门对着过道，南墙与厨房的南墙在一条直线上；卫生间为长方形，南墙长3米，另一边长2米。
7.卫生间的北面是次卧，同宽，门朝着过道，次卧长4米。
8.过道的北端是书房门，书房南北长4米，书房有一个一米见方的门厅，书房的西墙长4米，包括1米长的门厅长度，西墙把书房和次卧分隔开。门厅东墙北端90角折向东，长2米，把书房和厨房北阳台分隔开。
总之磨刀不误砍柴工。好的工程师，文档写得好是必要条件。
硬件工程师要写哪些文档：
1、需求跟踪表
在需求阶段明确需求，避免需求遗漏，避免需求理解差错，避免意淫需求。
2、总体设计
关键器件选型、方案框图，关键接口选择。
3、专题分析
时钟、电源、接口等等这些常规专题之外，我们还应该针对项目的薄弱点，制定特殊的专题文档。
比如双Flash启动，FPGA专题，一些你开发的电路板特有的，而且可借鉴的电路很少的，都需要做好理论分析，和试验验证。
4、规则驱动表单
不管是自己Layout，还是别人Layout，关键规则，例如电源走向、线宽、热设计要点、时序要求、信号质量要求等等。。。。
即作为Layout设计指导，也作为设计是否满足要求的checklist。
下面的目录文字，摘自《百度文库》：
其他每个环节都类似的文档，便于设计与记录。总之一个思路：把问题尽早暴露，避免问题遗留到项目的后面阶段。越早发现问题，改正问题，这样解决问题的代价越小。
返回搜狐，查看更多