分享
分享赚钱 收藏 举报 版权申诉 / 9

类型南京华苏科技有限公司案例编写规范V1.0new.doc

  • 上传人:dreamzhangning
  • 文档编号:2633832
  • 上传时间:2018-09-24
  • 格式:DOC
  • 页数:9
  • 大小:447.50KB
  • 配套讲稿:

    如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。

    特殊限制:

    部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。

    关 键  词:
    南京华苏科技有限公司案例编写规范V1.0new.doc
    资源描述:

    1、华苏科技案例编写规范 V1.0 内部公开9/24/2018 华苏科技机密,未经许可不得扩散 第 1 页, 共 9 页资料编码 产品名称使用对象 公司全体工程师 产品版本编写部门 技术部 资料版本华苏案例编写规范拟 制: 刘海林 日 期: 2011年 2月22 日星期二审 核: 日 期:审 核: 日 期:批 准: 日 期:南京华苏科技有限公司版权所有 侵权必究华苏科技案例编写规范 V1.0 内部公开9/24/2018 华苏科技机密,未经许可不得扩散 第 2 页, 共 9 页修订记录日期 修订版本 描述 作者华苏科技案例编写规范 V1.0 外部公开9/24/2018 华苏科技机密,未经许可不得扩散

    2、 第 i 页, 共 9 页目 录(TOC Heading)1 目的 .22 适用对象 23 案例编写提交规范 23.1 规范性: .23.1.1 案例 “标题”规范 .23.1.2 “现象描述”规范 .33.1.3 “告警信息”规范 .33.1.4 “原因分析”和“处理过程”规范 33.1.5 “建议与总结”规范 .33.1.6 “附件”规范 33.1.7 行文规范 43.2 保密性: .53.2.1 不出现局点名、地名、人名 53.2.2 不出现运营商名 53.2.3 涉及其它厂商设备时如何表达 .53.3 不可重复性: 63.3.1 严禁与网上已归档案例重复 6华苏科技案例编写规范 V1.

    3、0 外部公开9/24/2018 华苏科技机密,未经许可不得扩散 第 i 页, 共 9 页关键词:案例摘 要:技术案例的编写规范。缩略语清单:无参考资料清单:无华苏科技案例编写规范 V1.0 外部公开9/24/2018 华苏科技机密,未经许可不得扩散 第 2 页, 共 9 页1 目的为规范工程师提交案例的内容和格式,减少工程师因为内容、格式不符合标准而被退回情况,特制定此规范。2 适用对象全体工程师3 案例编写提交规范3.1规范性:3.1.1 案例 “标题”规范 故障类案例标题应突出“故障原因”和“故障现象”。标准格式为:“业务类型(可选)”“故障原因”“故障现象”例如:xxx业务xxx原因导致

    4、xxx故障, 以便于其他工程师查阅。 咨询类案例标题格式要求:FAQ-xxxxxxxx例如:1、FAQ-什么是 xxxxxxxx2、FAQ- 为什么 xxxxxxxx 标题中尽量避免出现断句现象,标题末尾不能有标点。 案例标题描述简洁清晰,字数小于30。3.1.2 “现象描述 ”规范现象描述包括版本信息(包括对接的其它厂家设备)、组网概述、故障现象的全面详细记录。要求详细、清晰,必要时可分小点描述。华苏科技案例编写规范 V1.0 外部公开9/24/2018 华苏科技机密,未经许可不得扩散 第 3 页, 共 9 页为了保持案例本身的层次感,不允许在这一部分花大量篇幅来说明“处理过程”。现象描述一

    5、项必须有信息描述,不可为空。3.1.3 “告警信息 ”规范告警信息,可描述设备网管告警台呈现信息、设备指示灯告警信息等。如案例无告警信息,则填写“无”。3.1.4 “原因分析 ”和“处理过程 ”规范原因分析是根据采集的故障现象,运用掌握的产品知识进行逻辑分析,从而得出处理问题的思路。处理过程是对实际操作过程的详细记录。案例中的原因分析和处理过程描述不能重复。“原因分析”和“处理过程”分小点描述时,序号后必须为顿号:“、”,每小点最后以“。”结束。各小点必须左对齐。“原因分析”一项如果为空,则必需填写“无”。“处理过程”一项必须有相关信息,不可为空。对于咨询类 FAQ 案例,处理过程一栏填写回答

    6、信息。3.1.5 “建议与总结 ”规范建议与总结部分应叙述针对故障现象可以采取的预防措施、日常维护建议等。对于资料和产品方面的建议请一律提交产品技术建议库。避免无实质内容的建议和总结。此项为空时则必须填写“无”3.1.6 “附件 ”规范附件包括组网图、信息跟踪、信令跟踪等等,不能和案例内容重复,已归档资料不能作为附件。不允许将附件内容直接贴在附件栏内,所有附件必须压缩成一个文件。对于附件中的内容,同样按照案例规范来要求。3.1.7 行文规范 标点符号华苏科技案例编写规范 V1.0 外部公开9/24/2018 华苏科技机密,未经许可不得扩散 第 4 页, 共 9 页中文案例则必须是中文输入状态下

    7、的全角中文标点符号。不应出现标点符号全部或部分为中文或中英文标点混杂的现象。不要滥用“!”,例如出现“要不然速度奇慢,要 2 小时左右!”等。 杜绝错别字例如“重起”、“登陆”、“用户筐”、“结觉问题”等。(翻译此例可省) 避免出现口语化、大白话例如:“搞掂了”、“因为和用户关系好,所以敢帮他重装系统”、“突然灵机一动”、“局方也不承认,关键是要找出证据来。”、“我司”、“我局”、“我端”、“我方”、“板子”、“架子”、“一条时隙”、“局方”等。 描述语气不能模棱两可(尤其是结论语句中)像“很可能是、估计是”等。 不允许涉及与技术无关的内容例如:“通过求助中研”、“向公司技术支持部的工程师 X

    8、XX 咨询”、“从故障发生开始,在经过办事处远程电话指导故障没有排除的情况下,办事处派出的工程师从 2 月 2 日上午开始就运用很多手段进行恢复处理。但传输中断还是时断时续,故障未能彻底排除,一时故障点定位困难,办事处压力越来越大。” 产品、版本名称规范对于涉及产品或者版本名称,不可以采用通俗的称呼方式,必须采用公司对外正式的客户产品名称,对于版本名必须采用公司规范的版本名称。例如:C&C08 交换机不可描述为“08 机”,V610R105M8008 版本不可描述为“8K 版本”。如果案例内容和版本补丁强相关,则必须在版本描述时精确到补丁版本。 案例各模块内容不可重复案例分为标题、现象描述、告

    9、警信息、原因分析、处理过程、建议与总结六个模块,故绝出现任意两个模块以上内容的简单拷贝,即各模块内容不可重复。华苏科技案例编写规范 V1.0 外部公开9/24/2018 华苏科技机密,未经许可不得扩散 第 5 页, 共 9 页3.2保密性:3.2.1 不出现局点名、地名、人名3.2.2 不出现运营商名案例中不要出现运营商名称,必要时用“某局”、“外局”等代替。描述互联互通类问题时不要出现运营商的特定接入码,例如:17909,用 179X9 代替。3.2.3 涉及其它厂商设备时如何表达以厂家代号表示,即:第一个大写英文字母“厂家”,例如:“爱立信”用“E 厂家”代替;“上海贝尔 ”用“B 厂家”

    10、;“西门子 ”用“S 厂家”等。设备名称采用第一个大写英文字母“X”的方式表示(X 长度与设备名称相等),例如:“S1240”用“SXXXX”。部分厂家代号:厂家 厂家代号北电 N 厂家爱立信 E 厂家上海贝尔 B 厂家西门子 S 厂家UT U 厂家中兴 Z 厂家朗讯 L 厂家思科 C 厂家3com 3c 厂家大唐 D 厂家富士通 F 厂家巨龙 J 厂家NEC NE 厂家阿尔卡特 A 厂家诺基亚 NK 厂家摩托罗拉 M 厂家港湾 H 厂家高科 G 厂家华苏科技案例编写规范 V1.0 外部公开9/24/2018 华苏科技机密,未经许可不得扩散 第 6 页, 共 9 页3.3不可重复性:3.3.1 严禁与网上已归档案例重复案例提交和审核时应该上网用关键字查找已归档案例,避免重复案例上网。

    展开阅读全文
    提示  道客多多所有资源均是用户自行上传分享,仅供网友学习交流,未经上传用户书面授权,请勿作他用。
    关于本文
    本文标题:南京华苏科技有限公司案例编写规范V1.0new.doc
    链接地址:https://www.docduoduo.com/p-2633832.html
    关于我们 - 网站声明 - 网站地图 - 资源地图 - 友情链接 - 网站客服 - 联系我们

    道客多多用户QQ群:832276834  微博官方号:道客多多官方   知乎号:道客多多

    Copyright© 2025 道客多多 docduoduo.com 网站版权所有世界地图

    经营许可证编号:粤ICP备2021046453号    营业执照商标

    1.png 2.png 3.png 4.png 5.png 6.png 7.png 8.png 9.png 10.png



    收起
    展开