文書にどのような依存関係がありますか？

Question

私はREADME.mdでhow to add dependenciesを質問するのではなく、自分の状況に合わせて文書化する方法を教えています。

SO Help Centerを見ると、これは「ソフトウェア開発に特有の実用的で解決不可能な問題」であると私は考えていました。

プロジェクトに関するガイダンスが必要です。要約すると...このプロジェクトは、私と契約した「ACME」と呼ばれる小規模ビジネスのための技術プロトタイプであり、顧客にサービスを提供するためにRaspberry Pisを分散型クライアントネットワークとして使用しています。 ACMEの所有者は技術的ではありません。彼はプロジェクトのシンプルさ、拡張性、安定性を重視し、不必要な混乱を避けたい。

私が関心を寄せているのは、私の直接の依存関係は2〜3つほどではありませんが、サブ依存関係は数多くあります。 （明確にするために、私はNode.jsのプロジェクトを、いくつかの小さなC++ワーカープログラムを除いてコーディングしています）。私がまとめて作業しているモジュールは、最大約40のサブ依存関係以上を集計します。

私にとって最も重要なことは、特にこれが開発者としての最初の公式な仕事であることで正しいことをすることです。アドバイスする上級開発者がいなくても私は自分ですべてです。

私の直接の依存関係（私が好むだろうが、依存関係自体を文書化する）、またはすべての依存関係をリストするだけですか？

Answer 1

npmは、あなた自身の依存関係をそれだけで（npm ls）リストできます。あなたは文書化する必要がありますシステムを起動し、、どのようにユーザーと開発者（あなたの後継者またはあなた自身のdevの設定を最初から復元する必要があります）として実行しています。

編集：さらに、自分のプログラムがシステム全体のコンポーネントとしてどのように適合しているかを文書化したいと思うでしょう。