Documentation and Handover

A scraper without docs becomes useless after some months.

Good documentation answers:

• what it does
• how to run it
• how to configure
• where data goes
• common errors

README example outline

# Project Name

## What it does
Scrapes product prices from example.com

## Setup
pip install -r requirements.txt

## Run
python main.py

## Config
Edit config.py

## Output
Data saved to SQLite DB

## Notes
Respect robots.txt

Inline code comments

# Fetch HTML from target URL
html = fetch(url)

Graph: knowledge transfer

flowchart LR
  A[Developer] --> B[Docs]
  B --> C[Next Maintainer]

Remember

• Write README
• Explain configs and outputs
• Your future self will thank you