Skip to main content

Installation instructions are complete

ab-000992 · developer-documentation.getting-started.install-instructions
Severity: criticalactive

Why it matters

Incomplete or missing installation instructions force every new developer to reverse-engineer the setup from source — inspecting package.json, searching for environment variables, and guessing at post-install steps. This breaks the adoption funnel at its first step. iso-25010:2011 analysability measures exactly this: the effort required to understand a system before using it. Vibe-coded projects frequently include generic boilerplate like a bare 'npm install' with no package name, no repository URL, and no mention of required setup steps that follow.

Severity rationale

Critical because without precise installation instructions, no external developer can run the project at all — every missing step multiplies abandonment probability, making adoption effectively impossible for anyone without insider context.

Remediation

Add an Installation section with the exact command needed. If the package is published to a registry, name it. If it must be cloned, show both steps:

## Installation

```bash
npm install your-package-name

Or from source:

git clone https://github.com/org/repo.git
cd repo
npm install

Include any post-install steps (database migrations, `.env` setup, seed data) before the first run command. Instructions must reference the actual package name, not a placeholder.

Detection

  • ID: developer-documentation.getting-started.install-instructions

  • Severity: critical

  • What to look for: Check the README and docs for step-by-step installation instructions. Verify they include the package manager command (npm install, pip install, cargo add, etc.), and that the instructions work for the project's actual setup. Check if prerequisites are mentioned before the install command. Before evaluating, extract and quote the first 3 steps from the installation instructions to verify they lead to a working setup. Count all instances found and enumerate each.

  • Pass criteria: Installation instructions include the exact command to install the package or clone and set up the project. Instructions are specific to the project (not generic boilerplate) and include any post-install setup steps. At least 1 implementation must be confirmed.

  • Fail criteria: No installation instructions exist, or they are generic boilerplate (e.g., "npm install" without specifying the package name), or they reference packages/tools that don't exist in the project.

  • Skip (N/A) when: Never -- every project needs installation instructions.

  • Cross-reference: The prerequisites check verifies the dependencies that must be documented alongside these install instructions.

  • Detail on fail: Describe the gap. Example: "README contains no installation section -- new users have no way to know how to install the package" or "Install instructions say 'npm install' but don't specify the package name or repository URL"

  • Remediation: Add a clear installation section. Include the exact command, and note if the package is published to a registry or must be cloned:

    ## Installation
    
    ```bash
    npm install your-package-name
    

    Or if cloning:

    git clone https://github.com/org/repo.git
    cd repo
    npm install
    

External references

Taxons

History