2016-12-13 186 views
0

爲了清楚起見,我並不是要求在一個README.md中使用how to add dependencies,而是根據我的情況如何處理它們。什麼依賴文件?

看着SO Help Center,我將其視爲「軟件開發所特有的一個實際的,可回答的問題」,我認爲在這裏提出問題是適當的。

我需要一些項目指導。總結...該項目是一個小型企業的技術原型,我將其稱爲「ACME」,與我簽訂合同,並將Raspberry Pis用作分佈式客戶端網絡,爲客戶提供服務。 ACME的所有者不是技術性的。他強調項目的簡單性,可擴展性和穩定性,我想避免不必要的混淆。

我擔心的是,雖然我的直接依賴關係很少,大約兩三個,但我的子依賴卻很多。 (爲了澄清,我在Node.js中編寫了這個項目,除了一些小的C++工作程序之外)。我正在使用的模塊總計大約有40個以上的子依賴關係。

對我來說最重要的事情就是做正確的事情,尤其是這是我作爲開發人員的第一份正式工作,而且我全都靠自己沒有高級開發人員來提供建議。

所以......我應該只列出我的直接依賴關係(我更喜歡哪個處理文檔來記錄它們的依賴關係),還是列出所有依賴關係?

回答

1

npm可以自己列出你的依賴關係(npm ls)。你需要記錄的內容是如何讓系統啓動並運行,無論是作爲用戶還是作爲開發人員(您的繼任者或將來您需要從頭開始恢復開發設置時)。

編輯:此外,您將要記錄如何將自己的程序作爲組件整合在一起。

+0

感謝您的意見!我已經開始記錄這些程序是如何一起工作的,但只是非正式的......現在我知道這是正確的方式,我會將其正式化。但是,「如何讓系統啓動並運行」是什麼意思?我將其作爲(在用戶端)作爲「鍵入終端的命令」進行了讀取,並且在開發者一方作爲「這使用了firebase,因此請確保您的服務器信息正確。」我對麼? – NonCreature0714

+0

是的,請將其作爲參考:https://github.com/iamstarkov/generator-zen – terales