编写技术文档的要求

技术文档的编写是公司对客户传递产品信息的重要手段之一，好的技术文档不仅仅在形式上严谨规范，在结构上层次分明，在技术内容上也必须十分的准确可靠。使用不准确的和不规范的技术文档，一旦客户在发现他们使用产品的时候遇到了问题，却不能通过求助于伴随产品的技术文档的手段进行解决的时候，客户们就会对这种产品产生怀疑乃至于失去信心。
在日常工作期间，我们所涉及的技术文档主要包括：项目建议书、可行性分析报告、施工组织报告、设计说明书等，由于每种技术文档的编写均具有相关性，但又均有其独特性。故本文就可行性分析报告的编写思路进行举例说明。
标准的可行性分析报告主要分为：前言、客户需求分析、现状分析、方案可行性分析、建设周期、建设费用、备用方案分析、结论八大部分。
第一部分：前言：
一、阐明编写可行性研究报告的依据、针对性及目的；
二、项目背景：应包括名称、客户单位、地点、相关关系、　计划任务书、合同、批文、标准或规范。
第二部分：客户需求分析
一、列出并说明客户基本要求。（如：功能、性能、效果、完成日期、安全与保密要求、完成日期等）
二、客户所要求达到的目标。（如：费用的节省、功能的增加、扩容的需求等）
第三部分： 对现状的分析
一、对现有设备性能、功能、环境的存在问题及为什么需要开发或变更的分析。
二、对现有人力、设备、空间、支持性服务、材料等资源分析。
第四部分：对方案可行性分析
一、对采用的系统或设备的简要分析；
二、与现有系统比较的优越性分析；
三、对采用新系统或设备的影响分析；
四、对收益/投资比、投资回收周期的分析。
第五部分： 建设周期
根据客户单位实际情况结合我公司实际情况对项目周期进行计划，满足客户在项目中时间的要求。
第六部分：建设费用
根据我公司对客户单位项目分析后的产品报价。（例如：产品清单、辅件清单、材料清单及运输费用清单等）
第七部分： 备用方案分析
逐个阐明其它可供选择的方案，并重点说明未被推荐的理由。
第八部分：结论意见
对项目在客户在时间上、性能上、功能上、费用上、可行性上等需求上是否满足明确的确认。
通过以前技术文档编写经验，总结出以下几点写作经验供大家参考：
一、 技术部分审核要高度细心及重视。在可行性方案中的技术部分审核应经常与技术人员进行沟通，对技术部分逐一审核，保证技术部分准确无误；同时对客户重点关心的技术指标部分予以高度重视。
二、 技术文档的编写中要明确责任。对

客户的项目不论大小均予以重视，明确相关技术人员及商务人员，保证客户在出现任何问题的情况下，均可联系到相关人员给予解决。
三、 文档编写人员需对项目全程有清楚的认识。由于技术文档的编写具有很强的全面性及宏观性，因此，要做一份好的技术文档需对项目全程均有清醒的认识和理解。
四、 清晰的头脑思路，理清事件顺序。一个项目简单的分可分为准备阶段、实施阶段及竣工阶段，而技术文档的内容含盖贯穿三大阶段，因此，技术文档编写人员必需有很好的头脑思路及处理顺序，才能保证后期实施中，整个项目能够按计划顺利的实施。



产品技术文档是公司产品对外宣传对外的重要“窗口”之一，好的产品技术文档不仅可以让客户清晰的了解产品的性能、技术指标、产品特点外，同时可以让客户更深入地了解公司的企业规模、服务方向及研发实力。