Documentation

Tutorials

Start here.

• Getting started — Configuration to your first proven story, one step at a time.
• Writing a citation — The one thing you write by hand — what goes in it, where it goes, and what it lets you say.

How-to guides

A specific situation, and the steps for it.

• A history beside the board — Keep a history alongside the board, so you can answer when something broke, how often it moves, and when anyone last looked.
• Installing Plumb — Install Plumb, verify what you installed, pin a version or a channel, or remove it.
• Recording a decision — Record a choice with the condition that would make it wrong, so its standing is derived rather than typed by whoever wrote it down.
• Tracking a parameter — Give a tuned value a model and a measurement, so whether the number still earns its place is derived rather than assumed.

Reference

Exact behaviour, when you already know what you want.

• The adapter contract — What a language adapter must produce for the core to read it.
• The command line — Every command and option, and how they cancel each other out.

Explanation

Why it works this way.

• Testing depth, and the roles it serves — What a depth claim means, and which role each rung serves.
• The tool and the method — Why Plumb requires no spec and no methodology, and what to install if you want one.
• Time per story — What a story takes to add, and what Plumb adds to every run of your suite.
• What to expect the first time — Why Plumb reports less than you expect, and what each surprise means.

By role

Exec / manager — Recording a decision · The tool and the method

PM / BA — Recording a decision · The tool and the method

Engineer — A history beside the board · Recording a decision · Testing depth, and the roles it serves · The tool and the method · Tracking a parameter · What to expect the first time

Programmer — A history beside the board · The adapter contract · The command line · Getting started · Installing Plumb · Recording a decision · Testing depth, and the roles it serves · The tool and the method · Time per story · Tracking a parameter · What to expect the first time · Writing a citation

QA / Test — Testing depth, and the roles it serves · Writing a citation

DevOps — A history beside the board · The command line · Getting started · Installing Plumb · Time per story