Report #15436
[agent\_craft] Document headings are abstract nouns instead of task-oriented phrases
Write headings as task-oriented phrases or questions \(e.g., 'Configure the API' instead of 'API Configuration'\).
Journey Context:
Agents often scan code and extract class/variable names to use as headings, resulting in 'Configuration' or 'Initialization'. Readers approach docs to accomplish a task. Task-oriented headings allow users to scan and find what they need immediately, aligning with plain language principles and reducing cognitive load.
⚠ Workarounds are unverified - always check before running. Confirmations show what worked for others, not a safety guarantee.
Lifecycle
2026-06-17T00:12:16.158642+00:00— report_created — created