要记录哪些依赖项?

What dependencies to document?

澄清一下,我不是在 README.md 中询问 how to add dependencies,而是根据我的情况如何处理记录它们。

看着SO Help Center,我看到了这个"a practical, answerable problem that is unique to software development,",我觉得在这里问是合适的。

我需要一些关于项目的指导。总而言之...该项目是一个小型企业的技术原型,我称之为 "ACME,"与我签约,并使用 Raspberry Pis 作为分布式客户端网络为他们的客户提供服务。 ACME 的所有者不是技术人员。他强调项目的简单性、扩展性和稳定性,我想避免不必要的混乱。

我开始担心的是,虽然我的直接依赖项很少,大约两三个,但我的子依赖项很多。 (澄清一下,我在 Node.js 中编写项目代码,但一些小型 C++ 工作程序除外。)我正在使用的模块总共有大约 40 个或更多的子依赖项。

对我来说最重要的是做正确的事,尤其是这是我作为开发人员的第一份正式工作,而且我完全靠自己,没有高级开发人员可以提供建议。

所以...我应该只列出我的直接依赖项(我更喜欢,并且自己处理记录它们的依赖项),还是列出所有依赖项?

npm 可以单独列出您的依赖项 (npm ls)。您需要记录的是如何启动系统和运行,作为用户和开发人员(您的继任者或您将来需要恢复时)从头开始你的开发设置)。

编辑:此外,您还需要记录您自己的程序如何作为整个系统中的组件组合在一起。