南京华苏科技有限公司案例编写规范v1.0new

《南京华苏科技有限公司案例编写规范v1.0new》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、华苏科技案例编写规范V1.0内部公开资料编码产品名称使用对象公司全体工程师产品版本编写部门技术部资料版本华苏案例编写规范拟制：刘海林日期：2011年2月22日星期二审核：日期：审核：日期：批准：日期：南京华苏科技有限公司版权所有侵权必究6/28/2021华苏科技机密，未经许可不得扩散第2页,共9页华苏科技案例编写规范V1.0内部公开修订记录日期修订版本描述作者6/28/2021华苏科技机密，未经许可不得扩散第2页,共9页华苏科技案例编写规范V1.0外部公开目录（TOCHeading）1目的22适用对象23案例编写提交规范23.1规范性：23.1.1案例“标题”规范2

2、3.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严禁与网上已归档案例重复66/28/2021华苏科技机密，未经许可不得扩散第6页,共9页华苏科技案例编写规范V1.0外部公开关键词：案例摘要：技术案例的编写规范。缩略语清单：无参考资料清单：无6/28/2021华苏科技机密，未经许可不得扩散第6页,共9页

3、华苏科技案例编写规范V1.0外部公开1目的为规范工程师提交案例的内容和格式，减少工程师因为内容、格式不符合标准而被退回情况，特制定此规范。2适用对象全体工程师3案例编写提交规范3.1规范性：3.1.1案例“标题”规范Ø故障类案例标题应突出“故障原因”和“故障现象”。标准格式为：“业务类型（可选）”＋“故障原因”＋“故障现象”例如：xxx业务xxx原因导致xxx故障，以便于其他工程师查阅。Ø咨询类案例标题格式要求：FAQ-xxxxxxxx例如：1、FAQ-什么是xxxxxxxx2、FAQ-为什么xxxxxxxxØ标题中尽量避免出现断句现象，标题末尾不能有标点。Ø案例标

4、题描述简洁清晰，字数小于30。3.1.2“现象描述”规范现象描述包括版本信息（包括对接的其它厂家设备）、组网概述、故障现象的全面详细记录。要求详细、清晰，必要时可分小点描述。6/28/2021华苏科技机密，未经许可不得扩散第6页,共9页华苏科技案例编写规范V1.0外部公开为了保持案例本身的层次感，不允许在这一部分花大量篇幅来说明“处理过程”。现象描述一项必须有信息描述，不可为空。3.1.3“告警信息”规范告警信息，可描述设备网管告警台呈现信息、设备指示灯告警信息等。如案例无告警信息，则填写“无”。3.1.4“原因分析”和“处理过程”规范原因分析是根据采集的故障现象，

5、运用掌握的产品知识进行逻辑分析，从而得出处理问题的思路。处理过程是对实际操作过程的详细记录。案例中的原因分析和处理过程描述不能重复。“原因分析”和“处理过程”分小点描述时，序号后必须为顿号：“、”，每小点最后以“。”结束。各小点必须左对齐。“原因分析”一项如果为空，则必需填写“无”。“处理过程”一项必须有相关信息，不可为空。对于咨询类FAQ案例，处理过程一栏填写回答信息。3.1.5“建议与总结”规范建议与总结部分应叙述针对故障现象可以采取的预防措施、日常维护建议等。对于资料和产品方面的建议请一律提交产品技术建议库。避免无实质内容的建议和总结。此项为空时则必须填写“无

6、”3.1.6“附件”规范附件包括组网图、信息跟踪、信令跟踪等等，不能和案例内容重复，已归档资料不能作为附件。不允许将附件内容直接贴在附件栏内，所有附件必须压缩成一个文件。对于附件中的内容，同样按照案例规范来要求。3.1.7行文规范Ø标点符号6/28/2021华苏科技机密，未经许可不得扩散第6页,共9页华苏科技案例编写规范V1.0外部公开中文案例则必须是中文输入状态下的全角中文标点符号。不应出现标点符号全部或部分为中文或中英文标点混杂的现象。不要滥用“！”，例如出现“要不然速度奇慢，要2小时左右！！！”等。Ø杜绝错别字例如“重起”、“登陆”、“用户筐”、“结觉问题”等

7、。（翻译此例可省）Ø避免出现口语化、大白话例如：“搞掂了”、“因为和用户关系好，所以敢帮他重装系统”、“突然灵机一动”、“局方也不承认，关键是要找出证据来。”、“我司”、“我局”、“我端”、“我方”、“板子”、“架子”、“一条时隙”、“局方”等。Ø描述语气不能模棱两可（尤其是结论语句中）像“很可能是、估计是”等。Ø不允许涉及与技术无关的内容例如：“通过求助中研”、“向公司技术支持部的工程师XXX咨询”、“从故障发生开始，在经过办事处远程电话指导故障没有排除的情况下，办事处派出的工程师从2月2日上午开始就运用很多手段进行恢复处理。但传输中断还是时断时续，故障未能彻