如何編寫友好的說明文件？

Jouzeyu發表於2020-04-12

一個優秀的專案應該有一個友好的說明文件，嚴格意義上講，說明文件應該包括以下幾點：

  • 專案簡介及創作動機
  • 專案維護、CI、依賴更新狀態（如果有）
  • features & 適用人群
  • 執行的平臺或硬體要求
  • 重要依賴
  • 如何安裝與測試
  • 使用示例及文件地址
  • 貢獻指南
  • License
  • 鳴謝
  • 其它特有的資訊

最近正在找工作，如果有意向，可以訪問招聘：[求職] 求職簡歷，求內推 檢視

本作品採用《CC 協議》，轉載必須註明作者和本文連結

空舟湖上~
     ——Jouzeyu

相關文章