1.文档管理

• 本文介绍
• 主要内容：
• 学习路径：
• 学习目标：
• 学习准备：

本文介绍

在前端工程师的世界里，需要与多个角色的人员打交道。

而文档作为前端工程师不可跨越的坎，必须是一项熟练技能。写好技术文档，不仅需要有很强的逻辑思维能力，而且还需要有好的工具与格式（工欲善其事，必先利其器）。那么，前端的技术文档有哪几类呢？

• 需求文档
• 接口文档
• 项目文档（描述性、功能使用性）
• 总结类型

主要内容：

• 项目文档之需求文档（书写格式）
• 需求文档的相关工具（原型图、流程图工具、文档管理工具）
• 文档管理之Markdown进阶（表格使用，包括流程图，甘特图，时序图）
• 文档管理平台MinDoc

学习路径：

• 需求文档的主要内容
• 需求文档格式
• 原型图，流程图介绍
• 需求文档工具及使用
• 学习描述文档的格式
• 了解描述文档书写注意事项
• 掌握功能说明、开发文档的书写方法
• 常见工具Typora使用及常见配置（主题）
• Markdown语法：流程图，甘特图，时序图

学习目标：

• 了解需求文档的基本内容
• 学会书写需求文档的基本格式
• 学会基础的需求文档的工具（流程图、原型图）
• 学会搭建MinDoc文档管理工具

学习准备：

Markdown编辑器Typora下载

Linux服务器，或者虚拟机（Centos 7.x），安装Docker服务

参见：https://www.daocloud.io/mirror