我們應該如何書寫README及文件

2021-09-26 14:31:53 字數 738 閱讀 4986

乙份好的文件可以減少很多溝通上的問題,這在團隊開發中至關重要。能夠寫出好文件的人,我相信在團隊中應該會更加受歡迎。那麼乙份好文件應該有哪些要素呢?

要素齊備:總有乙個內容是你想要的。

簡明扼要:能夠一句話說出你想表達的,說明你才對你的專案真正了解。當然有些東西沒法精簡。

ok 現在我們有了乙個基本概念了,那麼怎麼上手呢。

測試

部署

框架或者技術選型

貢獻者混個臉熟以後好搞事情

對於大家的參與表示精神上的鼓勵(ε=ε=ε=┏(゜ロ゜;)┛)

版本控制

作者

版權說明:

鳴謝:

你看到這篇文章的時候說明已經通過測試了?

本文部署在我的部落格上,你要部署就自己建乙個部落格,想怎麼部署都行.?

readme.md不知道你見過沒有.?

感謝以下貢獻者

我自己?

version: 1.0.0

我自己?

感謝各位對我的支援,看到這裡.

本文參考了purpleboothreadme-template.md感謝該作者的共享.

測試計畫應該如何書寫

測試計畫應該如何書寫 發言人個人認為起始時間為概要設計完成後 測試計畫內容 一 目的 測試計畫目的 背景 專案名稱 使用者等資訊。術語或定義 參考文件 二 2.1資源要求 測試環境的軟硬體 包括伺服器和客戶端,軟體的版本也要寫清楚 2.2人員及安排 包括任務 時間 人員及此任務輸出的產品。任務包括了...

我們應該如何保護使用者的密碼

最近幾年的新聞中一直有網際網路頭部公司系統被攻擊導致使用者密碼洩露的新聞。那密碼被破解肯定和當初專案伊始時選擇的密碼雜湊方案造成的歷史包袱有關。我們不討論這些網際網路巨頭應該採用什麼方案防止使用者密碼被破解,我知道的方案人家養的那些技術大拿更知道了。我們就來說一下,如果我們有機會自己從零開始做乙個系...

偽原創的出現我們應該如何防止

所謂偽自造,就是重新加工一篇文章,然後變成自己的東西,這是不誠實的舉動。這些年來,國家一直提出要與眾不同 技術是不同的。從這個角度看,偽自我創造與國內創新是對立的。不能滿足國家的發展需要,就會被社會選中,這是過去的規律,換言之,偽自我終有一天會被社會選中!那我們現在該怎麼辦?首先,我們必須改善我們的...