前端工程化

怎么写项目文档。现在很多团队都有内部代码托管平台，所以实际上文档的形式就是README，而打开项目的首页，首先看到的其实就是根目录下的README，它是整个项目文档的索引，我认为应该包括如下内容：

1. 项目名称+简单介绍+演示地址
2. 项目的安装，启动，调试，发布的完整步骤
3. 技术栈：方言（ts，sass），框架（vue/react…)，三方库（package.json中的dependencies下的所有）。并附上以上所有的链接，方便团队成员去补习一些前置知识
4. 如果有IDE的要求，最好附上一份通用的配置，方便其他成员导入就可以使用
5. 相关规范，比如：文件/文件夹的创建和命名规范即工程结构、Vue组件内的标签顺序（template>script>style）、常用变量的命名词库等
6. 其他。这里主要强调一下纪律，告诉成员们项目中的每个文件夹下面都有一份README在等着你，你得去看，全部看完了才可以开始开发，它们告诉了你每个文件夹里放的是什么，具体有什么作用，项目中已经有了哪些轮子，造轮子之前请三思！

模块化