关于技术文档写作格式的规定
2008、8、6
本文规定技术文档写作的标准格式，包括字体，字号，标题嵌套约定，行间距，插图、表格的绘制方法和标注方法，加黑，特殊颜色字体的使用，缩进，。。。。
执行本规定的意义：使不同撰写人的文档规范统一，便于公司统一整理和留存，也便于执行必要的再编辑工作。
一、字体
全文一律使用宋体
二、字号
封面标题三号宋体加黑
单文件标题四号宋体加黑
正文（含图表标题）一律用五号宋体，不加黑
单文件内一级标题五号宋体加黑
三、标题嵌套
举例说明如下：
4.XXX型YYY使用说明
①概述
本产品。。。。。。（不要在上述黑体字“概述”后面同行开始正文，应换行，下同）
②功能介绍
⑴。。。。功能；
A．Abcde
B．fghij
a.
b.
1)
2)
四、行间距
一律使用单倍行距（美观，节约纸张，统一视觉效果）
五、插图
插图必须用Windows系统的“绘图”工具来绘制，或者将原始图粘贴到“绘图”中后再拷贝到文档中。不允许在WORD中直接绘制，避免文件编辑时发生错误。
插图的名称标注方法：
1.位置：在图下，首字符从第10列开始
2.字体字号：5号宋体不加黑
3.序号写法：图12 XXX型YYY 接线端子图
4. 插图左右方空白位置不能写正文，不采用围绕方式
六、表格
表格必须用WORD中的“表格”工具绘制，应能正常进行再编辑。
表格的名称标注方法：
1.位置：在表格上方，首字符从第10列开始
2.字体字号：5号宋体不加黑
3.序号写法：表3 XXX行YYY器件清单
七、加黑
文档中对需要加重语气或提醒注意的地方可使用加黑，但不可太滥，可用情况如：
1.注意
2.特殊说明
3.接线图中的端子号，如：J5
4. 其他可能的情况
八、特殊颜色字体
除器件清单中特别重要的器件以红色标记外，其他文字一律使用黑色，不得使用其他颜色如蓝色等。（插图中的颜色除外）
本规定的意义：
1.标准保存文档的正常要求
2.审阅人签署修改意见时使用红色字体，避免发生混淆
九、缩进
正文书写应充分利用纸面的宽度，仅在各层次标题处进行缩进以示区别。自然段首行空2格，其他行一律不空格。
十、标点符号
1.标点符号的使用举例，下面两段很不相同，规定使用前一种。
A．现代企业，要求严格的管理。它是企业成功因素的一部分！
B．现代企业,要求严格的管理.它是企业成功因素的一部分!
2．应正确使用分号，破折号，省略号，删节号
3．若有括号在句尾，则标点符号在最后，见下例
本产品采用了高档微处理器（见图1）。
错误的写法是：
本产品采用了高档微处理器。（见图1）
十一、上下标和特殊符号的使用
1. 上标：如107 ，mm2
2. 下标：如V1，F x
3．正负号，摄氏度：±，℃
4．其他特殊符号，可在WORD的“插入-符号”工具中找到
十二、外文字母的写法
1. 字母大小写分清，如：kV ,kW ,P ,f ,DN等等。
2. 字母正斜体要标注清晰。
1）正体适用情况：计量单位、数学公式中的运算符号和缩写号、阿拉伯数字、其值不变的数学常数、指数函数、对数函数、三角函数等符号、化学元素符号、电气设备、仪器、元件等的型号。
2）斜体适用情况：用字母代表的量和一般函数、物理量符号、表示几何图形点、线、面的字母等。
十三、计量单位的使用及写法
1．一律采用法定计量单位。
2．在单位和阿拉伯数字连写时，单位用字母符号，如：3A,5V,345cal/(kW?h)等等，不用汉字，如：3安培，5吨/小时等等。
3．常用的字母大小写定义：
小写的：
小时，分钟，秒，毫秒h m s ms
公里，厘米，毫米km cm mm
大写的：
交直流电AC/DC
功率P= 100W
频率Hz f=1000M Hz
电压电流12V 3A
组合的：
速度km/h
电量KV A
电阻MΩKΩ
电感mH
电容μF
十四、公式的书写方法
1. 公式一定要有编号，如（1-1），（3-22）等，公式号居稿件的右侧。
2. 公式的输入要用正规模板，输入时注意正斜体的书写方式。
3. 公式书写举例。
P=VA (2-1)
式中P——功率，单位瓦特；
V——电压，单位伏特；
A——电流，单位安培。
十五、修改标记定义
文档初稿被审阅时，可能要做一些修改标记，其所表达的含义应予以明确，规定如下：1．修改意见用红色文字写出
2.对建议删除的字句，用方框框起来，如：
。。。。。（建议去掉）
3.对需要再斟酌的段落或字句，加下划线提示，如：
。。。。。。再上电就好使了。（建议对口语化文字做润色处理）4．对错别字加方框，并紧随其后用红色做修改，如：
。。。。。对讲室内机
5．□□这个标记表示要空两格
6．//。。。。。。。。。。。// 表示本段需要重新写
7. 其他复杂的意见，可用红色文字插入到原文的适当位置做说明，如：。。。。。。
本段的内容与标题不相符，建议修改：
1.。。。。
2.。。。。
3.。。。。
目录 一、页边距设置 (3) （一）、装订 (3) （二）、不装订 (3) 二、页面布局设置 (3) 三、目录 (3) （一）、目录选择 (3) （二）、字体 (3) （三）、段落 (3) 四、标题 (4) （一）、“字体”设置 (4) 1、主标题 (4) 2、副标题 (4) （二）、“段落” (4) 五、结构编号 (4) （一）、形式 (4) （二）、字体、段落 (5) 1、一级编号 (5) （1）、“字体” (5) （2）、“段落” (5) 2、二级编号 (5) （1）、“字体” (5) （2）、“段落” (5) 3、三级编号 (6) （1）、“字体” (6) （2）、“段落” (6) 4、四级编号 (6) （1）、“字体” (6) （2）、“段落” (6) 六、正文 (7) （一）、字体 (7) （二）、段落 (7)
（三）、落款、日期、签名规定 (7) （四）、图片 (7) （五）、附件 (9) 七、表格 (10) （一）、Excel电子表格。 (10) 1、页边距 (10) 2、标题 (10) 3、内容 (10) （1）、表头 (10) （2）、内容 (10) 4、列宽 (10) （二）、Word表格 (10) 八、页眉页脚 (11) （一）、格式 (11) （二）、内容 (11) 1、页眉 (11) 2、页脚 (12)
公司技术文档格式规范一、页边距设置 （一）、装订 纵向：上3cm，下2.5cm，左2.7cm，右2.5cm。 横向：上3cm,下2.5cm，左2.5cm，右2.5cm。 （二）、不装订 纵向：上3cm，下2.5cm，左2.5cm，右2.5cm。 横向：上3cm,下2.5cm，左2.5cm，右2.5cm。 二、页面布局设置 布局——页面设置——文档网格 选择“指定文档网格”，设置行数为每页40行。 三、目录 （一）、目录选择 使用引文目录，自动目录1. （二）、字体 “目录”两字：字体，宋体；字形，加粗；字号，四号。居中目录内容：字体，宋体；字形，不加粗；字号，五号。（三）、段落 自定义目录选项下修改目录段落格式。
目录 第一章引言 1 §1.1 目的 1 §1.2 文档约定 1 §1.3 预期读者和阅读建议 1 §1.4 产品的范围 1 §1.5 参考文献 1 第二章综合描叙 1 §2.1 产品的前景 1 §2.2 产品的功能 1 §2.3 用户类和特征 2 §2.4 运行环境 2 §2.5 设计和实现上的限制 2 §2.6 假设和依赖 2 第三章外部接口需求 2 §3.1 用户界面 2 §3.2 硬件接口 3 §3.3 软件接口 3 §3.4 通信接口 3 第四章系统特性 3 §4.1 说明和优先级 3 §4.2 激励响应序列 3 §4.3 功能需求 3 第五章其他非功能需求 3 §5.1 性能需求 3 §5.2 安全设施需求 4 §5.3 安全性需求 4 §5.4 软件质量属性 4 §5.5 业务规则 4 §5.6 用户文档 4 第六章其他需求 4 §6.1 词汇表 4 §6.2 分析模型 4 §6.3 待确定问题列表 5 第1章引言 引言提出了对软件需求规格说明的纵览，这有助于读者理解文档如何编写并且如何阅读和解释。 §1.1 目的 对产品进行定义，在该文档中详尽说明了这个产品的软件需求，包括修正或发行版本号。如果这个软件需求规格说明只与整个系统的一部分有关系，那么就只定义文档中说明的部分或子系统。 §1.2 文档约定
描述编写文档时所采用的标准或排版约定，包括正文风格、提示区或重要符号。例如，说明了高层需求的优先级是否可以被其所有细化的需求所继承，或者每个需求陈述是否都有其自身的优先级。 §1.3 预期读者和阅读建议 列举了软件需求规格说明所针对的不同读者，例如开发人员、项目经理、营销人员、用户、测试人员或文档的编写人员。描述了文档中剩余部分的内容及其组织结构。提出了最适合于每一类型读者阅读文档的建议。 §1.4 产品的范围 提供了对指定的软件及其目的的简短描述，包括利益和目标。把软件与企业目标或业务策略相联系。可以参考项目视图和范围文档而不是将其内容复制到这里。 §1.5 参考文献 列举了编写软件需求规格说明时所参考的资料或其它资源。这可能包括用户界面风格指导、合同、标准、系统需求规格说明、使用实例文档，或相关产品的软件需求规格说明。在这里应该给出详细的信息，包括标题名称、作者、版本号、日期、出版单位或资料来源，以方便读者查阅这些文献。 如： a．本项目的经核准的计划任务书或合同、上级机关的批文； b．属于本项目的其他已发表的文件； c．本文件中各处引用的文件、资料、包括所要用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 第2章综合描叙 这一部分概述了正在定义的产品以及它所运行的环境、使用产品的用户和已知的限制、假设和依赖。 §2.1 产品的前景 描述了软件需求规格说明中所定义的产品的背景和起源。说明了该产品是否是产品系列中的下一成员，是否是成熟产品所改进的下一代产品、是否是现有应用程序的替代品，或者是否是一个新型的、自含型产品。如果软件需求规格说明定义了大系统的一个组成部分，那么就要说明这部分软件是怎样与整个系统相关联的，并且要定义出两者之间的接口。 §2.2 产品的功能 概述了产品所具有的主要功能。其详细内容将在 d 中描述，所以在此只需要概略地总结，例如用列表的方法给出。很好地组织产品的功能，使每个读者都易于理解。用图形表示主要的需求分组以及它们之间的联系，例如数据流程图的顶层图或类图，都是有用的。 §2.3 用户类和特征 确定你觉得可能使用该产品的不同用户类并描述它们相关的特征（见第7 章）。有一些需求可能只与特定的用户类相关。将该产品的重要用户类与那些不太重要的用户类区分开。 §2.4 运行环境 描述了软件的运行环境，包括硬件平台、操作系统和版本，还有其它的软件组件或与其共存的应用程序。
X XX Q/ XXX （企业名称）企业规范 Q/ XXX 00 XX S-2012 （规范名称） 20 XX-XX-XX 发布20XX - XX - XX 实施
（企业名 发布称）
前言部分应视企业具体情况给出下列信息： 本规范的编写格式符合GB/T 1.1-2009《标准化工作导则第1部分：标准的结构和编写》的规定。 本规范贯彻了国家标准XXXX，参考了行业标准XXXX，地方标准XXXX，本规范的检验方法采用了相应国家标准的规定。 本规范由XXXX提出。 本规范起草单位：XXXX。 本规范主要起草人：XXXX。 本规范于XXXX年X月X日由XXXX负责人XXX批准。 本规范于XXXX年X月X日首次发布。 （规范名称） 1概述 本技术规范中的（设备名称）用使用。 2适用范围 本规范规定了……（设备名称）的产品分类、技术要求、生产加工过程的XXX要求、检验方法、验收规则、标志、包装、运输、贮运和售后。 本规范适用于……（设备名称）（说明产品由什么什么部件组成、经过什么样的工艺生产、使用什么样的材质等等），使用地点、使用单位等等。 3定义与术语
涉及的专业术语，或者关键性、重复性名称、等要素。（参考《GBT_1.1-2009_标准化工作导则 第1部分：标准的结构和编写》） 4基础条件 （设备名称）所使用的自然环境、工况等条件。 5执行标准和引用文件 下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。 示例如下：（常用的规范性引用文件） GB/T 191 包装储运图示标志 GB/T13306《标牌》 GB/T3181《漆膜颜色标准》 IS09001 —2008国际质量体系标准 【说明：它应列出标准中规范性引用的标准和文件一览表。一览表中文件排列的顺序为：国家标准、行业标准、地方标准、国内有关文件、ISO标准、IEC标准、ISO或IEC有关文件、其他国际标准即有关文件。国家标准、ISO标准、IEC标准按标准顺序号排列；行业标准、其他国际标准先按标准代号的拉丁字母顺序排列，再按标准顺序号排列。】 6技术参数 6.1外形尺寸示例： XXXX 6.2主要零件尺寸示例： 6.3材质要求示例： 6.3.1XX应符合XXXX标准的规定。 6.3.2……【说明：写明所有原辅料及执行标准】 6.4感官要求示例： 应符合表1的规定。
技术文件格式要求 1 目的 保证技术文件的规范化和标准化，体现公司的管理水平和专业技术人员的技术素质，便于技术文件的正确理解和实施。 2 范围 适用于公司范围内的所有项目部，当海外工程另有特殊要求时，可按具体规定执行。 3 一般要求 技术文件应贯彻国家、行业、企业的有关法令、规范、规程和标准，充分体现设计意图，针对作业项目，起到正确指导作用。 技术文件应表述简明、逻辑严谨、层次分明，优先选用图表方式描述。 技术文件应针对具体作业项目提出明确的要求，避免照抄各种规范标准。 文件中的称谓及名词，尽量使用中文，避免使用未经统一的英文字母代号。 行文语序必须符合汉语语言规范，不得英文直译。 正确使用数字、公式、符号、法定计量单位、代号、技术词汇、专业术语。 4 页面要求 纸张大小：A4，常规为纵向布置，特殊条件下横向布置。除附图附表外，不宜选用A3纸张。附图必须选用大于A4幅面的纸张时，应按国标折叠成A4幅面，以便于装订和存档 纵向页边距：上25mm，下20mm，左20mm，右20mm。 横向页边距：上20mm，下20mm，左20mm，右25mm。或在插入分节符后，设置页面横置，由WORD自动设置页边距。 页眉、页脚根据行文需要，当有页眉页脚需要时，页眉顶端距离，页脚底端距离厘米； 页眉页脚均不加隔离或标识性的横线及方框。 有装订需要时，纵向布置页面左侧装订，横行布置页面上部装订。装订线位置5mm。 根据文本内容需要，同一文本中页面变换时，应在本页面换页处设置分节符。 若无特殊要求，不宜设置水印、页面颜色及页面边框。 封面不设页眉、页脚以及公司标识等内容。 正文页眉可使用公司标识，标识尺寸要求见图（公司安全监督处文件《施工现场规范标识图册》）。 图页眉中公司标识示例 正文页脚可设置文件标识，如“XX装置XX施工技术方案”。 封面不设页码。目次多于一页时，以“i”、“ii”形式进行编页码。正文页码以“第 1 页
现场端技术档案和原始记录管理制度1 现场端技术档案和原始记录管理制度 一、技术档案（由运行维护人员建立备查，另外备份一套交企业存档） （一）在线监测数据小时均值全年度汇总记录。 (二）检测设备的生产厂家、安装单位、工程技术设计、施工、竣工资料和验收记录等。 （三)标准气体、标准液体和药剂的购置记录。 （四）药剂添加、更换记录。 （五）自动监控设备的校准、零点和量程漂移的例行检查报表。 (六)自动监控设备的例行检查记录。 （七)统一的每周巡检报告。 （八）计量机构的年检记录与环境监测机构比对检测记录。 （九）自动检测设备的检修登记记录。 (十)检测仪器的运行调试报告。 (十一)检测仪器的维护保养记录。 （十二)系统重大故障报告和原始记录。
(十三）应急处理方案。 （十四）设备的说明书、图纸、维护手册、布线、管理图,包括各种布线系统图、站房内机架及设备所在位置图、电源、配线设备的接线记录以及电路和用户资料。 二、原始记录 （一）周巡检记录。 （二）故障记录和质量统计分析资料。 （三）测试记录及电路电器持续记录。 （四)设备搬迁、更新的有关资料和测试记录。 (五）工作记录和其他原始记录。 三、基本要求 (一)档案中的表格必须采用统一的标准表格。 （二)记录必须清晰、完整,现场记录必须在现场及时填写,有专业维护人员的签字。 (三）与仪器相关的记录可放置在现场,所有记录均应妥善保存，用后留存归档。
现场端专职运行维护人员岗位职责1 污染源企业 现场端专职运行维护人员岗位职责 保证污染源现场端监控设施正常运行;定期向省、市（州)环境监控中心报告日常维护情况;建立运行维护技术档案；发现运行异常情况后及时向省、市(州）环境监控中心报告并进行处理。 一、运行维护人员须经过省级环保行政主管部门的培训并取得合格证书，持证上岗。 二、负责自动监测设备的日常维护、定期保养，确保设施正常运行。 三、负责自动监测设备的故障维修,并及时将故障及维修情况上报省、市（州）环境监控中心。 四、负责自动监测设备向省监控平台准确、稳定、有效的上传数据。 五、负责自动监测设备的定期校准、标定，定期配合当地环保行政主管部门监测机构对自动监测设备进行比对监测。 六、负责建立自动监测设备技术档案及运行档案。认真填写自动监测设备运行情况表,按要求做好相关记录和收集自动监测数据并存档,并及时填写试剂配制、更换及仪器维护情况表。 七、未经环保部门许可,不允许擅自停运自动监测设备。
技术总结写作 （汽车维修工） 一、技术总结写作基本知识 二、浅谈诊断电控发动机故障的方法与体会 温州长运集团奔驰代理公司洪振雪 三、浅谈汽车制动系统维修中的几点体会 温州公交集团东瓯公司李霄昉 温州交通技术学校 温州市汽车运用技术国家职业技能鉴定所 2009年4月 技术总结写作基本知识 总结：对前阶段工作、学习或思想情况进行回顾、检查、分析、研究、评价并作出书面结论的文体。 作用：对过去的实践活动肯定成绩，发现问题，总结经验，找出教训，引出规律性结论，明确今后实践方向的理性认识过程。 总结的特点： 1、真实性：事实说话，实践中选材，提炼观点，得出结论。 2、理论性：科学分析，就事论理，揭示事物规律性结论。 3、目的性：回答“怎么做”，指导未来。 总结的分类： 1、内容：工作总结，生产总结，学习总结、思想总结。 2、时间：定期性（年、季、月），工作周期为阶段。 3、范围：全面总结、专题总结、地区总结、单位总结、个人或部门总结。 4、功能：（1）汇报性：综合性、专题性； （2）经验性：理论性、指导性强。 总结格式： 1、标题： （1）陈述式：单位名称、时间、事由、文种； （2）论断式：正标题：内容、基本观点； 副标题：单位名称、内容范围、时间、文种； （3）概括式：简明扼要概述全文中心内容 2、正文： （1）前言： （2）主体： （3）结束语： 3、落款：署名、日期。 正文：三部分组成 1、前言：概括基本情况，写明总结时间、地点、对象、背景；基本经验、主旨；数据扼要说明主要成绩和问题。 以精炼语言，提示总结精萃之处，引起读者注意，对全文有大体印象。 2、主体：主要内容，包括： （1）主要成绩和收获；
投标文件技术部分格式 *注：投标文件的技术部分采用“暗标”评审，其封面、封底、装订、盖章以及其内页纸张、打印方式、文字、内容等，均按照本招标文件的投标人须知第19.8款的要求进行制作。
一、施工组织设计 1、投标人编制施工组织设计，包括招标文件第一章投标人须知11.4款规定的施工组织设计基本内容。编制的具体要求是：编制时应采用文字并结合图表形式说明各分部分项工程的施工方法；拟投入的主要施工机械设备情况、主要施工机械进场计划、劳动力计划等；结合招标工程特点提出切实际可行的保证工程质量、安全生产、文明施工、工程进度（工期）的技术组织措施，同时应对关键工序、复杂环节重点提出相应技术措施，如冬雨季施工技术措施、减少扰民噪音、降低环境污染的技术措施、地下管线及其他地上地下设施的保护加固措施等。 2、施工组织设计除采用文字表述外应附下列图表，图表及格式要求附后。 2.1 拟投入的主要施工机械设备表 2.2 劳动力安排计划表 2.3 计划开、竣工日期和施工进度网络图或横道图 2.4 施工总平面布置图 2.5 临时用地表
（一）拟投入的主要施工机械设备表（工程项目名称）工程 序号 机械或 设备名称 型号规格数量国别产地 制造 年份 额定功率 （KW） 生产能力 用于施 工部位 备注
二）劳动力安排计划表 （工程项目名称）工程单位： 按工程施工阶段投入劳动力情况 工种 注：1、投标人应按所列格式提交包括分包人在内的估计劳动力计划表。 2、本计划表是以每班八小时工作制为基础编制的。
三）计划开、竣工日期和施工进度网络图或横道图 1、施工进度网络图或横道图等施工进度表，说明按招标文件要求的工期进行施工的各个关键日期。中标后，中标人还将按合同条件有关条款的要求提交详细的施工进度计划。 2、施工进度表可采用网络图（或横道图）表示，说明计划开工日期和各分项工程阶段的完工日期以及分包合同签订的日期。 3、施工进度计划与施工组织设计相匹配。 （四）施工总平面布置图 投标人提交一份施工总平面布置图，绘出现场临时设施布置图表并附文字说明，说明临时设施、加工车间、现场办公、设备及仓储、供电、供水、卫生等设施的情况和布置。
设备技术资料档案管理 规定 集团企业公司编码：（LL3698-KKI1269-TM2483-LUI12689-ITT289-
设备技术资料、档案管理制度一、设备技术资料、技术档案是管好、用好、修好设备的依据，也是反映企业设备技术状况和设备经济效益的体现。设备技术资料、档案材料的收集、整理，要加强这方面的管理工作。 二、设备部在办完设备验收手续移交使用时，必须按照规定逐台统一编号，建立设备卡片和台帐；建立设备档案，要做到随机附件和技术资料齐全；进口设备的技术资料应及时全套翻译入档；每年进行复查核实，做到帐帐相符，帐、物、卡相符。 三、设备技术档案、设备管理记录包括： 设备的技术档案： 1、主要设备的技术标准、质量标准和图纸。 2、设备购置、更新改造、设备修理档案、修理项目的论证报告，技术协议和合同。 3、设备使用说明书、维修手册、配件目录、出厂合格证、装箱单等。
4、设备验收记录。 5、设备安装、调试和试运行记录。 6、设备调拨、售出记录。 7、设备事故记录、调查报告、处理结果。设备的管理记录： 1、设备的运转（运行）记录。 2、设备运转（运行）档案。 3、设备状态监测记录。 4、设备管理检查评比记录。 5、设备管理活动记录。 6、设备维修保养计划及相关记录。
7、非标机械加工计划及相关记录。 建立和及时维护设备管理信息系统，定期审查汇总设备报表并进行分析，做到及时发现问题。主要包括： 1、设备基础数据库。 2、设备运转记录数据库。 3、设备维修记录数据库。 4、设备状态监测记录数据库。 5、设备润滑检测及换油数据库。 定期上报设备管理报表。 1、主要设备经济技术指标季报和年报。 2、主要设备技术状况年报。 3、十五项总体指标年报。
目录 一、页边距设置 (4) (一)、装订 (4) （二）、不装订 (4) 二、页面布局设置 (4) 三、目录 (4) （一）、目录选择 (4) （二）、字体 (4) （三）、段落 (4) 四、标题 (5) （一）、“字体”设置 (5) 1、主标题 (5) 2、副标题 (5) （二)、“段落” (5) 五、结构编号 (5) (一)、形式 (5) (二）、字体、段落 (6) 1、一级编号 (6) (1）、 “字体” (6) （2）、 “段落” (6) 2、二级编号 (6) （1）、 “字体” (6) （2）、 “段落" (6) 3、三级编号 (7) (1）、 “字体” (7) （2）、 “段落” (7) 4、四级编号 (7) (1）、 “字体” (7) （2）、 “段落" (7) 六、正文 (8) （一）、字体 (8) （二)、段落 (8)
（三）、落款、日期、签名规定 (8) （四）、图片 (8) (五）、附件 (10) 七、表格 (11) (一)、Excel电子表格。 (11) 1、页边距 (11) 2、标题 (11) 3、内容 (11) （1）、表头 (11) (2）、内容 (11) 4、列宽 (11) （二）、Word表格 (11) 八、页眉页脚 (12) (一）、格式 (12) (二)、内容 (12) 1、页眉 (12) 2、页脚 (13)
公司技术文档格式规范一、页边距设置 （一）、装订 纵向：上3cm,下2。5cm，左2.7cm，右2.5cm。 横向：上3cm,下2.5cm，左2。5cm，右2.5cm。 （二）、不装订 纵向：上3cm，下2。5cm，左2.5cm，右2.5cm。 横向：上3cm，下2。5cm,左2.5cm，右2.5cm。 二、页面布局设置 布局—-页面设置-—文档网格 选择“指定文档网格”,设置行数为每页40行。 三、目录 （一）、目录选择 使用引文目录,自动目录1。 （二）、字体 “目录”两字:字体，宋体；字形，加粗；字号，四号。居中目录内容：字体,宋体；字形，不加粗；字号，五号. （三）、段落 自定义目录选项下修改目录段落格式。
软件开发技术文档编写规范 在项目开发过程中，应该按要求编写好十三种文档，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。 ◇可行性分析报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。 ◇项目开发计划：为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。 ◇软件需求说明书（软件规格说明书）：对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。 ◇概要设计说明书：该说明书是概要实际阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计提供基础。 ◇详细设计说明书：着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。 ◇用户操作手册：本手册详细描述软件的功能、性能和用户界面，使用户对如何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。 ◇测试计划：为做好集成测试和验收测试，需为如何组织测试制订实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。 ◇测试分析报告：测试工作完成以后，应提交测试计划执行情况的说明，对测试结果加以分析，并提出测试的结论意见。 ◇开发进度月报：该月报系软件人员按月向管理部门提交的项目进展情况报告，报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。 ◇项目开发总结报告：软件项目开发完成以后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力，此外，还需对开发工作做出评价，总结出经验和教训。 ◇软件维护手册：主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明，便于软件的维护。 ◇软件问题报告：指出软件问题的登记情况，如日期、发现人、状态、问题所属模块等，为软件修改提供准备文档。 ◇软件修改报告：软件产品投入运行以后，发现了需对其进行修正、更改等问题，应将存在的问题、修改的考虑以及修改的影响作出详细的描述，提交审批。 1可行性分析报告 1 引言 1.1 编写目的：阐明编写可行性研究报告的目的，提出读者对象。
附2: 软件文档编写向导 文档分类 项目包括如下几类文档： 项目管理文档。包括：《软件项目计划》、《项目进度报告》、《项目开发总结报告》 软件开发文档。包括：《需求规格说明》、《概要设计说明》、《详细设计说明》、《测试计划》、《软件测试分析报告》。 产品文档。包括：《用户操作手册》《演示文件》。 软件项目计划 （Software Project Plan） 一．引言 1．编写目的（阐明编写软件计划的目的，指出读者对象。） 2．项目背景（可包括：（1）项目委托单位、开发单位和主管部门；（2）该软件系统与其他系统的关系。） 3．定义（列出本文档中用到的专门术语的定义和缩略词的原文。） 4．参考资料（可包括：文档所引用的资料、规范等；列出资料的作者、标题、编号、发表日期、出版单位或资料来源。） 二．项目概述 1. 工作内容（简要说明项目的各项主要工作,介绍所开发软件的功能性能等. 若不编写可行性研究报告,则应在本节给出较详细的介绍。) 2. 条件与限制（阐明为完成项目应具备的条件开发单位已具备的条件以及尚需创造的条件. 必要时还应说明用户及分合同承包者承担的工作完成期限及其它条件与限制。） 3. 产品 （1）程序（列出应交付的程序名称使用的语言及存储形式。） （2）文档（列出应交付的文档。） （3）运行环境（应包括硬件环境软件环境。）
4．服务（阐明开发单位可向用户提供的服务. 如人员培训安装保修维护和其他运行支持。）5．验收标准 三．实施计划 1．任务分解（任务的划分及各项任务的负责人。） 2．进度（按阶段完成的项目,用图表说明开始时间完成时间。） 3．预算 4．关键问题（说明可能影响项目的关键问题,如设备条件技术难点或其他风险因素,并说明对策。） 四．人员组织及分工 五．交付期限 六．专题计划要点（如测试计划等。） 项目开发进度报告 一．报告时间及所处的开发阶段 二．给出进度 1．本周的主要活动 2．实际进展与计划比较 三．所用工时（按不同层次人员分别计时。） 四．所有机时 五．工作遇到的问题及采取的对策 六．本周完成的成果 七．下周的工作计划 八．特殊问题 项目开发总结报告 一．引言 1．编写目的（阐明编写总结报告的目的,指明读者对象。）
【最新整理，下载后即可编辑】 目录 一、页边距设置 (4) （一）、装订 (4) （二）、不装订 (4) 二、页面布局设置 (4) 三、目录 (4) （一）、目录选择 (4) （二）、字体 (4) （三）、段落 (4) 四、标题 (5) （一）、“字体”设置 (5) 1、主标题 (5) 2、副标题 (5) （二）、“段落” (5) 五、结构编号 (5) （一）、形式 (5) （二）、字体、段落 (6) 1、一级编号 (6) （1）、“字体” (6) （2）、“段落” (6) 2、二级编号 (6) （1）、“字体” (6) （2）、“段落” (6) 3、三级编号 (7)
（1）、“字体” (7) （2）、“段落” (7) 4、四级编号 (7) （1）、“字体” (7) （2）、“段落” (7) 六、正文 (8) （一）、字体 (8) （二）、段落 (8) （三）、落款、日期、签名规定 (8) （四）、图片 (8) （五）、附件 (10) 七、表格 (11) （一）、Excel电子表格。 (11) 1、页边距 (11) 2、标题 (11) 3、内容 (11) （1）、表头 (11) （2）、内容 (11) 4、列宽 (11) （二）、Word表格 (11) 八、页眉页脚 (12) （一）、格式 (12) （二）、内容 (12) 1、页眉 (12) 2、页脚 (13)
公司技术文档格式规范 一、页边距设置 （一）、装订 纵向：上3cm，下2.5cm，左2.7cm，右2.5cm。 横向：上3cm,下2.5cm，左2.5cm，右2.5cm。 （二）、不装订 纵向：上3cm，下2.5cm，左2.5cm，右2.5cm。 横向：上3cm,下2.5cm，左2.5cm，右2.5cm。 二、页面布局设置 布局——页面设置——文档网格 选择“指定文档网格”，设置行数为每页40行。 三、目录 （一）、目录选择 使用引文目录，自动目录1. （二）、字体 “目录”两字：字体，宋体；字形，加粗；字号，四号。居中目录内容：字体，宋体；字形，不加粗；字号，五号。（三）、段落 自定义目录选项下修改目录段落格式。 目录1：左侧缩进0字符；特殊格式为无，1.2倍行距，其余均设
技术档案管理制度 XX工程有限公司 xx年六月十五日
目录 1、机构设置和职责分工 2、工程技术档案资料的编制 3、技术档案资料的组成 4、各项资料的填写、签字、格式及整理规定 5、竣工技术资料的管理 6、技术档案的鉴定和销毁 7、技术档案的保管和借阅 8、公司工程技术档案职责划分表
技术档案管理制度 为建立、健全公司技术档案工作，完整地保存和科学地管理公司的技术档案，充分发挥技术档案在公司建设和发展中的作用，更好地为公司各生产技术部门服务。特制订本管理制度。 一、机构设置和职责分工 1、公司工程技术档案管理机构 2、职责分工 (一）、总工程师 总工程师负责整个工程的档案管理工作，组织制定本项工程的归档范围、管理制度、收集整理工程前期文件，组织审查、接收各部门编制的档案文件。 （二）、综合部 （1）、公司档案室的直接管理部门，负责建立规范的公司档案室，设
立专职工程技术档案管理人员。 （2）、负责根据国家和行业的档案法规，制定公司工程技术档案管理制度，报公司批准后，印发各部门执行。 （3）、及时向公司档案室移交本部门构成档案元素的工程项目资料。（三）、公司档案室 （1）、负责公司工程技术资料及档案的日常管理工作，负责图纸、设备资料、合同文件、信函传真文件、综合文档等的接收、发放、借阅及其登记、微机录入及编码归档。 （2）、负责归档数据库的数据备份。 （3）、负责指导公司各部门收集、整理相关工程技术资料。 （4）、负责档案设施、设备的维护管理，负责库存工程技术档案的安全及保密工作。 （5）、负责达标投产的资料整理工作。 （四）、工程部 （1）、建立规范的工程技术资料室，设立专职工程技术档案管理人员。（2）、督促参建各单位（包括监理单位、施工单位、调试单位）严格遵守公司工程技术档案资料管理办法，并纳入合同条款中进行管理。（3）、协调参建各单位工程技术资料管理的重大问题。 （4）、审定经过监理单位审查的各类技术资料，并及时移交资料室。（五）、工程部资料室 （1）、负责图纸、设备资料、技术协议、信函传真文件、综合文档等的接收、传递及移交公司档案室前的保管。
技术文档如何写 作者：曾盛开（广智公司技术一部） 拥有准确的技术文档不仅对于公司是非常有益处的，而且也能够让客户从中受益。由于产品如何使用在某种程度上是要依赖技术文档来进行说明的，因此技术文档必须十分的准确可靠。使用不准确的和已经过时的技术文档对于公司的发展也会产生一定的阻碍，同样的，它也会对公司的客户们产生消极的影响。一旦客户发现在他们使用产品的时候遇到了问题，却不能通过求助于伴随产品的技术文档的手段进行解决的时候，客户们就会对这种产品产生怀疑乃至于失去信心，那么，公司的信誉和利益自然而然的就会受到损害。这就是不准确的和过时的技术文档给我们带来的危害。 缺乏准确性以及内容晦涩难懂都会让开发新手以及其他的一些技术工作者们对这些技术文档敬而远之，从而不利于他们的学习和掌握。在本篇文章中，我们要讨论的就是如何在你的开发小组中编写出准确而且易于掌握的技术文档。 技巧一：制定出一个技术评价核对表 许多的程序开发设计者以及管理者都缺乏从技术上评价一个文档的经验。这里有一些方法可以提高这些技术文档的准确性： 把注意力集中于技术事实上，这样能够核实这些技术是作为技术文档而被编写出来的。技术评论的工作并不等同于一般的编辑工作。 一定要从技术上核实，在技术文档里编写的程序与步骤的准确性。 一定要从技术上核实，在技术文档中使用的图片捕捉的准确性。 技巧二：一定要在技术文档编写的过程中明确责任 技术文档编写不好的一个原因常常是由于对它不够重视。这是由于在编写技术文档的时候，没有十分的明确各种责任。因此，一定要在技术文档编写的过程中明确责任，这些方法包括： 在技术文档中加入作者以及相关人员的姓名。一些公司可能有规定，禁止出现员工的姓名，但是在技术文档中包含作者以及相关人士姓名的做法能够促进这些内部员工之间的交流。对于外部的文档使用者，比如为商业现货软件编写的用户指南，可以加入作者以及相关人员的姓名，用以明确和承认他们对开发所做的工作和贡献。 把文档的技术评论作为提供给开发设计人员的年度评论的一部分。 在项目计划中指派专人负责技术评论的工作。 技巧三：增加技术文档编写者的准确性 由于技术文档编写者在许多公司内都是非常主观的一个职位，并且编写技术文档也是他们最主要的职责，因此做这些工作的人都必须与他们所编写的技术文档的准确性有着直接的利害关系。 管理人员应该为技术文档编写者设置适当的技术准确级别，并要求他们把准确性保持在这一范围之内。由于一些技术文档编写者对于提升自己对于技术的理解总是不太积极主动，因此，增加他们的责任让他们面对更多的压力对项目里的每一个人来说都是有好处的。如果一个技术文档编写者无法达到更高的标准，那么你就需要重新审视一下你的技术文档编写者是否能够满足你们的团队的战略要求，是否能够满足客户们的需要呢？ 为了帮助技术文档编写者，你需要让他们对于具体的技术有着更深层次的认识，因此，作为管理者，你应该： 让技术文档编写者多参加有关产品设计与开发的小组会议。 让技术文档编写者参与到技术要求、功能规范以及设计方案的开发工作中去。
技术档案管理制度 一、归档时间 办理完毕的文件，按工作阶段性进行归档： 1、按年形成的文件，第二年上半年归档。 2、凡是有法律效用的文件材料，一生效就归档。 3、凡是有机密性的文件，随时形成，随时归档。 4、特种设备重大维修验收及年检验收合格后，三个月内归档。 二、归档要求 1、材料完整齐全。 2、系统、条理、保持有机联系。凡是归档文件材料，均要按其不同特征组卷，尽量保持它的内在联系，区分它们不同的保存价值。文件分类准确、立卷合理。 3、立卷时，要求将文件的正件与附件，印件与定稿，请示与批复等统一立卷，不得分散。 4、在进行卷内文件排列时，要合理安排文件的先后秩序，按时间先后排列。对于同一事情的同一文件，应统一规定进行，比如：正件与附件，应正件在前，附件在后等。 5、由档案部门对特种设备管理部门加以指导，协助特种设备管理部门共同做好旧档的组织工作。办理移交手续，双方在移交清册签字。 三、归档流程 1、编制立卷项目，将办理完毕的文件按有关条款归入卷内，便于次年立卷。
2、文件按时间顺序排列，最近的在最上面。 3、一台特种设备一个立卷，一个档案盒。 4、定时交档案室：文件量少的，一年交一次，次年上半年收集。文件量大的，一年交两次，次年上半年和下半年各一次。 5、记录档案文件材料须用碳素笔写。在无特殊情况下，须用A4纸。 四、档案管理工作 1、档案的管理：区分全宗，正确立档单位；分类，依据档案、来源、时间、内容、形式分成若干层次和类别；案卷排列并编制案卷目录。 2、档案保管：本单位设立专用文件库保存档案。 3、档案的鉴定：从档案的内容、来源、时间、可靠程序、名称鉴别、档案价值，确定各类档案的保管期限，编制成表。 4、档案的销毁编制销毁清册；办理销毁手续，经总经理批准，方能销毁；销毁要有二人以上监销，并在清册上签字。 五、档案利用工作 1、凡需调阅档案，均须填写档案借阅单，依据借阅权限和档案密级，经有关领导签批后方能借阅。借阅档案应在“档案借阅登记簿”上登记，注明借阅档案的名称、密级、借阅方式、数量、期限。 2、档案利用方式有：提供档案原件；提供档案复印件；提供文献索引资料。 3、依据国家统计和有关法律法规，做好本公司档案统计工作。
高新技术企业立项报告撰写技巧 高新技术企业认定过程中，一个重要的环节是考察企业的科研组织管理能力，企业能否提交符合要求的立项报告成为考察的重要指标，高质量的立项报告需要注意以下几个方面，希望对您能有所帮助： 一、项目、产品市场调查和需求预测 1.国内外市场调查和预测： (1) 根据本项目产品的主要用途，进行市场分析，并预测本企业产品所占市场份额。 (2) 从项目产品质量、技术、性能、价格等方面，分析本项目产品的国内外市场竞 争能力。 2.分析本项目产品市场风险的主要因素及防范的主要措施。 对项目的风险性及不确定因素进行分析，包括技术风险、市场风险、政策风险等，并分析项目的抗风险能力。 二、项目技术可行性分析 1.项目关键技术及创新点的论述； 2.项目产品的技术性能水平（指标）与国内外先进水平的对比； 3.技术成熟性和可靠性论述： (1)技术成熟性的论述及有关部门对本项目技术成果的技术鉴定情况； (2)本项目产品的技术检测、分析化验的情况； (3)本项目产品在实际使用条件下的可靠性、安全性的情况等。 三、项目实施方案 1.技术方案论述 简述实施本项目的技术方案。 2.生产（或实施）方案论述 根据本企业在生产设备、生产地点、辅助设施等方面已具备的条件，论述实施本项 目的方案。 3.产品营销计划 论述本项目产品营销方式、营销计划和保障措施。 四、项目实施目标
包括项目完成时实现年生产能力、项目产品达到的技术、质量标准。 五、投资估算、资金筹措 1.投资估算 根据项目建设要求，估算项目总投资总额及资金使用安排。 2.资金筹措 按资金来源渠道，分别说明各项资金来源、预计到位时间。 六、经济、社会效益分析 1.经济效益分析 估算项目产品的生产成本和总成本，并分别列表计算结果。预测项目完成时项目产品年销售收入、年净利润、年交税总额等情况。 2.社会效益分析 主要体现对社会的贡献。 七、项目可行性分析结论
信息网络运行、设备管理和维护、技术文档管理记录(总1 页) -CAL-FENGHAI.-(YICAI)-Company One1 -CAL-本页仅作为文档封面，使用请直接删除
1、信息技术文档所指范围：计算机硬件、网络设备的资料；医院信息管理系统；采用数字设备采集制作的图像文件；用于信息发布的影像资料；各种备份数据；使用视频捕获设备录入或使用软件生成的影像文件；用音频设备录入的声音文件；软件开发活动中形成的程序文件和参数文件。 2、信息技术文档所含种类：纸质文档、电子文字文档、电子表格、视频文档、音频文档、电子图像、光学存储介质、U盘存储介质。 3、信息技术文档收集、整理分红、黄、绿三级。红色级别：重要的信息数据备份、重要信息技术参数文档、政策规范信息技术资料、信息相关法律法规资料等；黄色级别：硬件驱动程序、软件安装程序、硬件设备使用说明手册、系统软件操作说明等；绿色级别：培训课件、学习资料记录等。４、信息技术文件收集、整理要求是为确保信息技术文档的真实性、完整性、可识别性、保密性，采取加以防范的管理制度： 1）定期每月5日至10日对红、黄级文档进行备份，对重要文件应脱机保存，分异地备份，15日至20日对绿级文档进行收集整理； 2）在条件允许的情况下，将部分重要信息技术文档设定为只读方式，不可对其进行修改和删除等恶意篡改操作； 3）红、黄级部分文档在条件允许的情况下，采用加密技术，确保文档真实、有效性； 4）与黄级文档相关的支持信息和背景信息、数据资料，规为绿级文档管理； 5）红级文档保存为一式两份，分信息管理科集中管理备存和异地封存。黄级文档统一收集，由信息管理科管理以备查阅调用。绿级文档列为普通文档管理，科室自行管理备存。
神州数码（中国）有限公司 秘级：内部保密文件仅限内部使用 概要设计说明书模板 （V1.2） 文档编号：DC-QG-23-01 文档名称：概要设计说明书编写：沙存孝编写日期：1999.7.16 审核：钱增祺审核日期：1999.7.16 神州数码（中国）有限公司
用户名称 神州数码（中国）有限公司 秘级： 项目名称 概要设计说明书 （版本号） 文档编号：项目名称： 编写：编写日期： 审核：审核日期： 神州数码（中国）有限公司[项目名称]项目组
文档修订记录
目录 第一章引言 (6) 第一节编写目的 (6) 1.1.1作用 (6) 1.1.2预期读者 (6) 第二节编写背景 (7) 1.2.1 系统名称及版本号 (7) 1.2.2 任务提出者 (7) 1.2.3 任务承接者及实施者 (7) 1.2.4 使用者 (7) 1.2.5 与其它系统的关系 (7) 第三节文档结构 (7) 第四节电子文档编写工具 (7) 第五节定义说明与符号规定 (8) 第六节参考资料 (9) 第二章系统概述 (9) 第一节系统目标 (9) 第二节设计原则 (9) 第三节运行环境 (9) 2.3.1 硬件平台 (9) 2.3.2 软件平台 (9) 2.3.3 网络体系结构 (10) 第四节应用软件整体结构概述 (10) 第五节关键技术 (10) 第三章数据库设计 (11) 第一节数据组织 (11) 3.1.1数据分布方式 (11) 3.1.2数据传输与通讯 (11) 3.1.3 历史数据管理 (11) 第二节实体集列表 (11) 第三节概念数据模型图 (12) 第四节数据量估计 (14) 第五节数据分布方案 (14) 第六节实体与基本表的对应关系 (14) 第七节物理数据模型图 (15) 第八节数据库系统介绍 (15) 第四章代码设计 (16) 第一节背景介绍 (16) 第二节编制说明 (16) 第三节代码表列表 (17)
如何编写高质量的软件文档 摘要： 本文首先阐述了软件文档的重要性；接着描述了软件文档的分类和编写原则、技巧；最后针对我们在编写概要设计说明书中存在的不足，提出了一些指导性原则和大家分享。通过这次分享，希望对大家编写概设等文档时有所帮助。 正文： 我在面试的时候，发现好多公司面试官都不问我写代码的能力如何，JAVA的熟练程度如何，而问我口头和书面表达能力如何，写方案的能力如何，他还说，你写的代码可能只有你的团队或将来维护你程序的人来看；而高层领导，老板和客户他们只看文档的，不会看你的代码的（不是说代码不重要，保证程序运行的正确性和提高代码的运行效率是程序员最基本的能力和职责），刚开始觉着很奇怪，可仔细想想，确实是那样，像我们这种写了多年代码的程序员来说，除了写好代码，其实写得一手好文档尤其重要，文档写不好是程序员向上发展的瓶颈，要提升自己可以先从编写高质量的文档开始。 对于软件开发人员来说，除了保证程序运行的正确性和提高代码的运行效率之外，规范化的文档编制将会对软件的升级、修改、
维护带来极大的方便。因此，开发一个高质量的软件产品，除了完成软件程序本身编制外，还必须提供完整详细的软件文档。 在软件生命周期中，软件文档记载了所有与软件有关的需求、开发、方法等核心技术信息，是保证软件项目开发、运行、维护和管理的重要技术资料。 为了何证软件开发、维护等环节的有效管理以及方便软件技术人员之间进行技术交流，在软件生命周期的每一阶段，都需要编制不同内容的文档。这些文档连同计算机程序及数据一起，构成计算机软件。 软件文档也称做软件文件，是一种重要的软件工程技术资源，例如技术文档、设计文档。软件文档和计算机程序共同构成了能完成特定功能的计算机软件，因此可以说没有文档的软件，不能称其为软件，更不能成为软件产品。 软件文档的规范编制在软件开发工作中占有突出的地位和相当的工作量。高质量地编制、分发、管理和维护文档，及时地变更、修正、扩充和使用文档，对于充分发挥软件产品的效益有着十分重要的意义。 一、软件文档的重要性 软件文档作为计算机软件的重要组成部分，在软件开发人员、软件管理人员、软件维护人员、用户以及计算机之间起着重要的桥梁作用，软件开发人员通过软件文档交流设计思想和设计软件；软件管理人员通过文档了解软件开发项目安