Principle
Attach the source next to the claim it supports
A source is most useful where the reader needs to verify the statement.
When it fits
- A message ends with a pile of links and screenshots whose purpose is unclear.
When to avoid it
- Links can rot and permissions can fail; preserve required evidence according to the system's retention rules.
Why it matters
Place the relevant link, log, document section or screenshot beside the claim or action it supports. Add a short label describing what to inspect. This reduces hunting and makes unsupported statements visible.
An example
Instead of 'logs attached,' write 'Activation completed at 10:42 — see SLG1 screenshot, row 3.'
Check your result
A reviewer can move from an important claim to its evidence in one step.
Keep this limit in mind
- Links can rot and permissions can fail; preserve required evidence according to the system's retention rules.
Connected ideas
Useful withShow the delta when a requirement changes
Evidence and sources
CDC guidance recommends lists, chunks and descriptive headings to make information easier to scan and organize.
Very short messages may not need headings; structure should match complexity.
Description and Examples of Index Items · Core items 8 through 10
ONS guidance recommends writing around user needs, removing content that does not serve those needs, and using concise task-focused headings.
Regulated or audit-heavy work may require context that feels redundant to the immediate reader.
Writing and editing: Plain language · Put users' needs first; titles and headings; be concise