インストールセクションのベストプラクティス

インストールセクションのベストプラクティス

インストールセクションは、多くの潜在的ユーザーがプロジェクトを続行するか放棄するかを決定する場所です。明確で機能するインストール手順は譲れません。

複数のパッケージマネージャーを表示

npm、yarn、pnpmのインストールコマンドを表示します。

開発依存関係を区別

パッケージが開発時のみ必要な場合：

npm install --save-dev my-linter

グローバルとローカルのインストール

CLIツールの場合、違いを説明します。

システム要件

インストールコマンドの前に要件をリストします。

プラットフォーム固有の手順

インストールがプラットフォームによって異なる場合、macOS、Linux、Windowsの手順をそれぞれ文書化します。

インストールの検証

常に検証ステップを含めてください：

my-tool --version
# Expected output: my-tool v2.1.0

トラブルシューティング

一般的なインストール問題に対する簡単なトラブルシューティングセクションを追加します。