README-学习笔记

为何要有README

• npm包中的README
  • 让你的用户快速了解，如何安装、使用你的项目、以及如何与你合做
• 工程项目中的README
  • 项目多人协做让新参与进来的人员或者项目交接时交接人员可以快速上手减小沟通

npm包中的README如何编写？

以让你的用户快速了解，如何安装、使用你的项目、以及如何与你合做为基础写readme

• 让用户快速了解你的包是作什么的
  • 功能简介 - 直观让用户了解你实现的功能
  • 效果图(或演示地址) - 直观的让用户知道你的实现效果是否跟他想要的同样
  • changelog - 告诉用户该包哪一个版本实现了哪些功能
• 如何安装和使用你的项目
  • 集成方式 - 安装包的方式
  • 使用方法 - 给出示例
• 如何与你合做
  • 做者信息
  • 版权信息
• 额外的
  • 徽章 - (build, codecov, downloads, start, issues, license)

个人README

项目中的README如何编写?

以让项目多人协做让新参与进来的人员或者项目交接时交接人员可以快速上手减小沟通为基础编写README

• 开发环境配置
  • 配置host之类的，安装相关的软件(vscode,node,npm，zeplin, filezilla...)
• 开发及运行程序
  • 项目环境，scripts命令等
• 错误告警及监控 - 错误告警及监控查看地址等
• 访问地址
  • 项目正式环境、测试环境访问地址
• 常见问题
  • 开发中须要注意的问题
• 相关文档地址
  • 产品文档
  • 接口文档
  • 开发规范文档
  • 开发计划文档
  • 项目部署文档