文档撰写规范V2.3.doc

联想MS知识库 文档模板规范 V2.3

联想MS知识库
文档模板规范

技术中心技术工具与知识管理处
2011/12/20

1 通用格式要求
1.1 题目部分：
1.1.1 标题：
使用黑色宋体四号字居中呈现。

注：在MS知识库创建为：

1.1.2 其他：
标题和正文之间空一行，空行部分通过硬回车完成。
1.2 正文部分：
1.2.1 基本要求：
全文以黑色宋体五号字，左对齐呈现。

全文回车使用硬回车。
1.2.2 分段标题：
文档内分标题以黑色宋体五号字加粗，左对齐撰写。
示例：
适用范围：
文档内分标题和上一个段落中间空一行。
1.2.3 层级关系：
正文部分如果需要用标号体现步骤和层级关系，统一使用如下示例所示的编号规则，缩进为子编号比上级编号向右两个单位，和文字中间使用半角空格。可以使用Word 中的相同样式的自动编号（和文字的空格可省略）。
示例：
1
1.1
1.1.1

1.3 图片部分：
1.3.1 图片尺寸：
横向像素数不能超过 480，纵向不限。图片尽可能保证相关界面的完整性。
1.3.2 图片清晰度：
截图原图（96dpi）横向尺寸（像素数）小于或等于480的，文档中原大（不能放大）使用。截图原图横向尺寸（像素数）大于400的，优先无缩放剪裁到横向尺寸480使用。如剪裁无法保证图片信息完整，可少量等纵横比缩小使用，缩放结果横向尺寸（像素数）等于或小于480。且横向和纵向尺寸（分辨率）分别不能低于原横向和纵向尺寸（分辨率）的80%。以保证图片清晰度。
1.3.3 图片格式：
图片采用 JPG 或 GIF 格式。
1.3.4 图片编号：
插入图片编号需以阿拉伯数字标号。前后加中文圆括号，在图片下方居中。
1.3.5 图片位置：
图片在文档中居中显示。图片上下各空一行。
1.3.6 图片内容：
图片中内容强调部分请使用矩形红色框提示。
图片中需隐藏部分请使用白色矩形框覆盖。
图片示例：

（图1）

1.4 句式语法部分：
1.4.1 语句中的英文单词
中文语句中的英文单词、数字前后加中文半角空格。
示例：
如何清理 Internet Explorer 浏览器缓存？
1.4.2 缩写规范
英文缩写全部用大写表示。
示例：
ADSL，VPN 等
错误：
Adsl，vpn 等
1.4.3 商品正式名称
文档中出现的软件名称或产品名称全部使用全称（商品正式名称），不能使用缩写或者简写。
示例：
Windows 7，Windows XP，昭阳 K46A 等
错误：
Win7，winxp，k46 等
1.4.4 引用的文字
正文中引用软件、硬件产品标识中的文字，需前后加双引号。
示例：
点击“控制面板”
2 内容结构部分
2.1 常见问题文档模板
2.1.1 题目
题目简要描述主要的问题现象，结构为“问题现象”加“的解决方案”。次要和中间环节的现象描述在题目中阐述，避免标题过长。

示例：
Windows 7 系统下 ADSL 自动断线的解决方案
错误：
Windows 7 系统下ADSL 连接一段时间之后会自动断线的解决方案
2.1.2 故障现象
详细阐述故障现象、发生条件、所处环境等。尽量以图文并茂的形式呈现。
2.1.3 原因分析
（此项目为选填项）。
对故障原因进行简单判断和分析，判断过程需要有前后递进逻辑关系。
2.1.4 解决方案
详细阐述故障解决过程，尽量图文并茂表现，步骤完整，不能有跳步现象。应具有较强的指导性。
2.1.5 备注
（此项目为选填项）
主要阐述作者需要补充说明的部分。
2.1.6 维护范例
Windows 7 系统下 ADSL 自动断线的解决方案

故障现象：
Windows 7 系统下 ADSL 连接一段时间之后会自动断线。

原因分析：（选填）
可能原因为启用了“闲置自动断线功能”导致。

解决方案：
打开“控制面板”－“网络和 Internet”－“网络和共享中心”－“更改适配器设置”。（图1）

（图1）

在宽带连接上点右键，选择“属性”。（图2）

（图2）

选择“选项－挂断前空闲时间”，设置为“从不”即可。（图3）

（图3）

备注：（选填）
2.2 操作指导文档模板
2.2.1 题目
题目包含操作对象和本文介绍的操作方法所要达到的目的。
如“Internet Explorer 浏览器”为说明对象，“清理缓存”为所要达到目的。

2.2.2 适用范围
此部分主要阐述说明对象对于此文档的使用范围。
如软件版本、系统环境、硬件配置、网络环境等。
2.2.3 要点分析
（此项目为选填项）。
主要阐述本文操作后达到的效果，及操作过程中涉及的知识点，发生原因。
2.2.4 操作步骤
此部分阐述使说明对象达到指定目的具体实施过程，是文档最重要部分。需详细说明完整步骤。尽可能做到图文并茂，通俗易懂。
2.2.5 备注
（此项目为选填项）
主要阐述作者补充说明，需单独强调和请读者留意的内容呈现。
2.2.6 维护范例
清理 Internet Explorer 浏览器缓存的操作方法

适用范围：
Internet Explorer 全版本

要点分析（选填）：
为了提高访问网页的速度，Internet Explorer 浏览器会采用累积式加速的方法，将你曾经访问的网页内容（包括图片以及 cookies 文件等）存放在电脑里。这个存放空间，我们就称它为 IE 缓存。以后我们每次访问网站时，Internet Explorer 会首先搜索这个目录，如果其中已经有访问过的内容，那 Internet Explorer 就不必从网上下载，而直接从缓存中调出来，从而提高了访问网站的速度。

操作步骤：
打开 Internet Explorer ，选择“工具—internet 选项”，切换到“高级”选项卡，找到“关闭浏览器时清空 internet 临时文件夹”，将其选中，点击确定即可。

备注（选填）：
2.3 维修案例文档模板
2.3.1 题目
题目包含故障对象和故障现象，必须指出该案例的特殊性，如问题产生的特定环境、简要的导致原因等。

示例：
“Lenovo G460 连接 AC 电源适配器不加电”
错误：
“Lenovo G460不加电”
2.3.2 涉及产品
如果此案例涉及硬件产品，阐述所涉及的硬件厂商、产品型号、产品系列，要求与商品名相同，不能缩写或改写。多个产品的情况下，不同的厂商、产品型号、产品系列都独占一行；
如果此案例涉及系统或软件产品，阐述此系统或软件的全称及版本号，要求与原名相同，不能缩写或改写。多个产品的情况下，不同的产品、版本单独占一行
2.3.3 故障现象
详细阐述故障现象、发生条件、所处环境等。尽量以图文并茂的形式呈现。
2.3.4 维修过程
主要呈现维修检测过程（先软后硬、先外后内、先连线后部件），可以按照检测思路按顺序撰写，尽量做到图文并茂。
更换部件尽量写明部件名称、编号，替换系统、软件版本尽量写明下载地址，方便其他工程师参考。
2.3.5 案例总结
（此项目为选填项）
对本案例的处理思路、解决方案进行总结阐述。
2.3.6 维护范例
Lenovo G460 连接 AC 电源适配器不加电

涉及产品：
Lenovo G460

故障现象：
一台 Lenovo G460，主机编号 CB04765039，接 AC 电源适配器的情况下不加电，用电池开机正常。开机状态下连接 AC 电源适配器自动断电。

维修过程：
根据用户报修问题，更换 AC 电源适配器测试，故障依旧。把用户电脑的 AC 电源适配器放在同一型号的电脑测试，开机正常。故 AC 电源适配器好无故障，故障源在主机部件。更换主机电源接口线测试，故障排除，所以锁定故障为电源接口线。次日更换时发现屏轴压着电源接口线导致短路，用户新购机，20天内15天外，只能选择维修，断定可能出厂时组装不到位导致，用户未维修过，维修时看见易碎贴完好。

案例总结：
屏轴压着电源接口线短路导致接 AC 电源适配器的情况下不加电，更换电源接口线解决。
2.4 用户手册文档模板
2.4.1 题目
题目包含厂商名称+产品名称+“用户手册”结构，或厂商名称+产品名称+“配置”结构，产品名称使用全称（正式名称），不能使用缩写或者简写。如产品名称中可以标识出厂商，则可以不填写厂商名称
2.4.2 适用产品
填写适用的产品
硬件产品，阐述所涉及的硬件厂商、产品型号，产品系列，要求与商品名相同，不能缩写或改写。多个产品的情况下，不同的厂商产品、产品型号、产品系列都独占一行。
系统或软件产品，阐述此系统或软件的全称及版本号，要求与原名相同，不能缩写或改写。多个产品的情况下，不同的产品、版本单独占一行。
示例：
Lenovo V470 系列
Lenovo V570 系列
Lenovo B470 系列
Lenovo B570 系列
2.4.3 文件信息
文件名称：完整文件名（包含扩展名），需与下载的附件名一致，如“V470&V570&B470&B570 UserGuide V1.0 (10.12.13)_web.pdf”；
文件版本：大写字母V+半角空格+版本号（阿拉伯数字），如“V 1.3”；
文件大小：以兆（M）或字节（K）为单位，如“3.1 M”；
文件格式：填写文件的扩展名，如“.pdf”。
2.4.4 备注
（此项目为选填项）
主要阐述作者需要补充说明的部分。
2.4.5 维护范例
Lenovo V470/V570/B470/B570 用户手册

适用产品：
Lenovo V470 系列
Lenovo V570 系列
Lenovo B470 系列
Lenovo B570 系列

文件信息：
文件名称：V470&V570&B470&B570 UserGuide V1.0 (10.12.13)_web.pdf
文件版本：V1.0
文件大小：2.85M
文件格式：.pdf

备注（选填）：
2.5 技术通报文档模板
2.5.1 题目
题目包含通报编号和通报题目，中间用半角空格分割。
2.5.2 故障现象
详细阐述故障现象、发生条件、所处环境等。尽量以图文并茂的形式呈现。
2.5.3 解决方案
详细阐述故障解决过程，尽量图文并茂表现，步骤完整，不能有跳步现象。应具有较强的指导性。
2.5.4 适用产品
填写适用的产品
硬件产品，阐述所涉及的硬件厂商、产品型号，产品系列，要求与商品名相同，不能缩写或改写。多个产品的情况下，不同的厂商产品、产品型号、产品系列都独占一行。
系统或软件产品，阐述此系统或软件的全称及版本号，要求与原名相同，不能缩写或改写。多个产品的情况下，不同的产品、版本单独占一行。
2.5.5 备注
（此项目为选填项）
主要阐述作者需要补充说明的部分。
2.6 光盘镜像文档模板
2.6.1 题目
题目包含适用厂商名称、产品名称、光盘内容概述。产品名称使用全称（商品正式名称），不能使用缩写或者简写。
2.6.2 适用项目
2.6.3 适用产品
填写适用的产品
硬件产品，阐述所涉及的硬件厂商、产品型号，产品系列，要求与商品名相同，不能缩写或改写。多个产品的情况下，不同的厂商产品、产品型号、产品系列都独占一行。
系统或软件产品，阐述此系统或软件的全称及版本号，要求与原名相同，不能缩写或改写。多个产品的情况下，不同的产品、版本单独占一行。
2.6.4 镜像内容
阐述详细的光盘内容，如有多张光盘内容不同，需写明每张光盘的内容。
2.6.5 文件信息
以表格形式呈现文件名称、文件大小、备注信息。
示例：
文件名称
大小
备注

2.6.6 备注
（此项目为选填项）
主要阐述作者需要补充说明的部分。
2.6.7 维护范例
ThinkStation E20 Windows 7 Professional 64bit 简体中文系统恢复光盘（with office 2010 starter）

使用项目：
所有项目

适用产品：
ThinkStation E20 （4219、4220、4221,、4222、4215）

镜像内容：
ThinkStation E20 Windows 7 Professional 64bit 简体中文系统恢复光盘（with office 2010 starter）

文件信息：
文件名称
大小
备注
DISK1 71Y7100.iso
3.21G

DISK2 89Y0840.iso
4.34G

DISK3 89Y0841.iso
1.93G

DISK4 89Y6527.iso
1.15G
Additional Software Recovery Disc
（表1）

备注（选填）：
1.1 工具下载文档模板
1.1.1 题目
题目包含适用产品厂商名称、产品名称、附件内容和版本，之间用半角空格隔开。使用全称（商品正式名称），不能使用缩写或者简写。如产品名称中可以标识出厂商，则可以不填写厂商名称。

示例：
联想万全 T350 G7/T280 G3 BIOS V1.13/BMC V1.00
1.1.2 适用产品
填写适用的产品
硬件产品，阐述所涉及的硬件厂商、产品型号，产品系列，要求与商品名相同，不能缩写或改写。多个产品的情况下，不同的厂商产品、产品型号、产品系列都独占一行。
系统或软件产品，阐述此系统或软件的全称及版本号，要求与原名相同，不能缩写或改写。多个产品的情况下，不同的产品、版本单独占一行。

示例：
联想万全 TR350 G7 Rack主机
联想万全 TR350 G7 塔式主机
1.1.3 使用方法
（此项目为选填项）
详细说明使用方法，如BIOS下载，要详细描述刷新方法，尽量图文并茂。
1.1.4 更新明细
逐条阐述此版本附件的更新内容，如是初始版本，填写“无更新”。
1.1.5 文件信息
文件名称：填写完整文件名（包含扩展名），需与下载的附件名一致。
BIOS 版本：大写字母V+半角空格+版本号（阿拉伯数字）。
文件大小：填写文件大小，以兆（M）或字节（K）为单位。
1.1.6 备注
（此项目为选填项）
主要阐述作者需要补充说明的部分。
1.1.7 维护范例
联想万全 T350 G7/T280 G3 BIOS V1.13/BMC V1.00

适用产品：
联想万全 TR350 G7 Rack主机
联想万全 TR350 G7 塔式主机

使用方法：
刷新 BIOS，进入 0349\\bios 目录下，运行 flash.bat，等待刷新结束。
刷新 BMC，进入 0349\\bmc 目录下，运行 flash.bat，等待刷新结束。

更新明细：
无更新

文件信息：
文件名称：3049.rar
BIOS 版本：BIOS V1.13 BMC V1.00
文件大小：2.57M

备注：
该BMC只能在888-011405和888-011404上刷新，不能在低版本主板上刷新。低版本BIOS及BMC刷新文档参看编号为39462的文档。

3 内容类型定义列表

管理分类
内容类型
内容类型说明
1
技术类
常见问题
常见故障的解决方案
2
技术类
操作指导
产品安装及使用指导
3
技术类
维修案例
解决用户问题的典型案例
4
技术类
培训教材
业务培训，新品培训及介绍性文档
5
技术类
用户手册
产品随机的用户手册、部件的技术手册、产品配置等
6
技术类
技术通报
关于质量问题解决方案的通报
7
下载类
光盘镜像
系统、驱动等工作相关内容的镜像
8
下载类
工具下载
BIOS、工具、软件、驱动等工作相关内容的下载
9
管理类
流程规范
标准操作流程、流程规范、服务规范等
10
管理类
政策法规
服务政策、补充解释、特殊类的服务政策等
11
管理类
标准话术
针对客户技术、事务等问题的标准解答话术
12
项目类
项目合同
保存项目合同相关文档
13
项目类
项目发文
渠道管理人员向项目成员发送的项目发文
14
项目类
通知公告
知识库的最新动态、重要通知及项目经理向项目工作人员发送的公告。
15
客户类
客户专用
提供签约用户专用的内容。

附：内容类型-目录对应表

模板名称
正文目录
常见问题
故障现象
原因分析
解决方案
备注
操作指导
适用范围
要点分析
操作步骤
备注
维修案例
涉及产品
故障现象
维修过程
案例总结
用户手册
适用产品
文件信息
备注
技术通报
故障现象
解决方案
适用产品
备注
光盘镜像
适用项目
适用产品
镜像内容
文件信息
备注
工具下载
适用产品
使用方法
更新明细
文件信息
备注
培训教材

流程规范

政策法规

标准话术

项目合同

项目发文

通知公告

客户专用

18