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命令等
• 錯誤告警及監控 - 錯誤告警及監控查看地址等
• 訪問地址
  • 項目正式環境、測試環境訪問地址
• 常見問題
  • 開發中須要注意的問題
• 相關文檔地址
  • 產品文檔
  • 接口文檔
  • 開發規範文檔
  • 開發計劃文檔
  • 項目部署文檔