如何撰写出优秀的技术文档

技术文档分为两类，一类指开发中要用到的研发文档，一类是给客户看的客户文档，技术文档不仅仅适用于SaaS开发，他在各个领域都很常见，能够帮助记录团队/公司内部的一些资料，便于员工进行查询，通过正确的方法，将文档存储在同一地方，帮助员工理解并节省时间成本。

• 什么是技术文档
• 技术文档的类型
• 技术文档的作用
• 如何制作技术文档

什么是技术文档？ 

技术文档的核心是描述产品相关内容，包括产品的使用方法、特性和功能，不仅仅适用于产品开发人员，各个利益相关者都依赖此文档，包括产品设计师、销售人员和营销人员以及客户。

你可以使用技术文档来：

• 解释产品的使用方法、功能
• 将产品的相关内容集中管理
• 便于团队提高工作效率
• 便于信息的查找

技术文档的类型

基于项目的技术文档

基于项目的技术文档通常供开发团队使用，解释如何制作产品，包括详细的步骤和流程。主要包括项目时间表、内部的会议记录和报告、产品开发相关内容。

基于产品的技术文档

基于项目的技术文档主要是面向企业内容，但是产品技术文档通常面向外部客户，主要是向用户简单介绍产品，让用户清楚了解产品如何使用，例如：如果客户对产品使用有问题，那么他们可以基于产品技术文档进行自行解决。

技术文档的作用

改善客户体验

技术文档为用户提供及时的信息，改善用户使用体验，提高客户