Skip to content

Specs, plans and other documents

An item’s documents sit next to it in items/:

items/87.md the item
items/87.spec.md its spec
items/87.plan.md its plan
items/87.report.md any items/<n>.<type>.md

A document belongs to an item by its file name: nothing else links them. The board shows each one as a tab beside the item’s text, and moving the item to another lane renames its documents with it.

Terminal window
primum doc 87 spec --file spec.md

or write the file yourself in any editor.

An item can show a document that belongs to another item by listing it in its front matter:

docs: [items/80.spec.md]

Useful when one spec covers several items. Deleting #80 removes the entry from every docs list.