如何写文档?
第一步:下载文档模板¶
请使用标准文档模板
| PPT模板 | template.pptx |
| 硬件文档模板 | hw_spec_t.doc |
| 软件文档模板 | sw_spec_t.doc |
| 时序图模板 | visio时序图模板.rar |
第二部:文档命名¶
文件命名规则: ProjectName_Catalog_Version.doc (全部采用小写英文字母)
| ProjectName | 项目名称 | |
| Catalog | 文档类型 | |
| HW:硬件Spec文档 | ||
| SW:软件Spec文档 | ||
| RP:研究报告 | ||
| Version | 版本号,一般从0.1开始 | |
比如: secid_sw_0.6 : 指的是项目secid的软件spec 0.6版文档
第三步:撰写文档¶
原则:详细、清晰、易懂、图文表结合
请参考sony公司的spec例子
L_MIF_spec_rev010Ja.pdf - SONY LSI的IP Spec样例 (1.34 MB)
hw_spec_t.doc - 硬件文档模板 (261 KB)
sw_spec_t.doc - 软件文档模板 (108 KB)
visio时序图模板.rar - 时序图模板 (195 KB)
template.pptx (65.9 KB)