前端技术文档编写思路

最近在编写前端技术调研文档和概要设计文档，下面是个人的一些小的常规总结。

1.前端技术调研文档

编写思路大致分为以下几个方面   整体概述、相关技术介绍、相关技术的插件或工具库使用

操作系统及版本、浏览器支持

下面是一个示例    我这里使用  网页端截图相关内容

1.1.调研概述

对调研内容进行一个整体的概括，如该调研基于Html2Canvas技术，介绍一下相关技术

1.2.插件介绍

使用了相关的插件库，并简单介绍这一插件库

1.3.插件具体使用

在相关代码中引入该插件库，包含具体使用相关插件库

1.4.操作系统及版本

列出插件适应操作版本，以及低版本下会出现的情况

1.5.相关浏览器支持

对于主流浏览器的兼容性支持，并调研相关差异性

2.概要设计文档

2.1.设计基本介绍

大致介绍相关功能设计的设计需求

2.2.相关功能设计需求分析

分析相关功能设计的需求,复杂流程可添加必要的业务逻辑流程图

2.3.功能介绍

分步骤介绍相关功能

2.4.数据的输入与输出

相关功能的传参，入参和出参，建议以表格形式呈现

2.5.前端方面的设计实现思路

这里分步骤介绍相关设计实现思路，突出前端业务逻辑

2.6.功能效果截图

在文档内展示相关功能效果截图，对2.5 实现思路进行内容补充

2.7.相关补充

补充说明该概要设计的内容，可以是相关项目配置版本等内容