产品用户手册、模板说明标准规范手册、产品应用笔记、工程技术笔记、产品数据手册、产品用户手册的模板在此仅保留第1、2页,省略了销售与服务网络、目录以及正文部分。相关模板的完整版本,请参照相应的电子文档。读者通过学习作者制定的模板之后,也可以根据需要自行设计相应的模板。
(1)样式和格式因产品简介手册、标准规范手册、产品应用笔记、工程技术笔记、产品数据手册和产品用户手册文档模板的特殊性,除正文外的其它内容,包括它们的字体、大小、颜色等按照模板本身所具有的格式不再进行修改,正文除一级标题外的其它格式全部按照“文档写作规范”的格式要求进行定义。一级标题字体使用黑体(中)、Arial(西)、四号,编号使用“1.功能简介”,左对齐,标号与标题文字之间1个空格。文档的版本号在未发布前统一用V0.xx,正式发布后版本个位数不为“零”,如用V1.xx、V2.xx。
(2)编号
公司文档均统一编码,采用“产品线+具体产品+文档序号”的编码方式,产品线编码由项目管理部门统一控制,具体产品由事业部经理发放,文档序号由项目负责人发放。冗长的数字编码会造成口头校对的麻烦,特别是在编码没有隔断符号的时候。在创建本套编码规则的时候,已经考虑尽可能缩小编码的长度,但长达8位的数字还会造成口误。为了解决口头校对的问题,应当分段表达,以保证对方准确记录。读UM01010215时应当说UM,0101,0215。必须注意到以上规定仅限于口语表达,文书上依然不会采用这种方式。
如果您想深入了解具体的编码规范,可以参考这篇编码规范文档,以及这篇详细的C#编码规范文档。当然,还有非常实用的Java编码规范参考文档,其中包含了详尽的编码准则和示例。对于海尔产品的编码规则,您可以查看这篇海尔产品编码规则,获取更多信息。
具体文档编码规则如下:
文档类别文档的类别定义、基本要素、特性及适用范围的详细说明见表2.1,基本要素仅供参考,建议文档撰写人仅作章节的删减,而不要变更章节名称,以保证公司文档结构整齐统一。
难道不想让自己的文档结构更加整齐、编码更加标准吗?如果是的话,那么这些资源将是您的最佳指南!
暂无评论