skim-001 should GuidesAPI docs Lead with the most important information; front-load key points so content is scannable.
Writing for skimming
Most readers of developer docs scan a page for the piece they need rather than reading top to bottom. This page covers how to order information so that scanning works. Related structural tools — headings, paragraphs, and lists — have their own pages.
Front-load key information
Section titled “Front-load key information”Examples
- ✓ Quotas limit how many requests each project can make. This page shows how to view and raise them.
- ✗ Before we discuss quotas, it helps to review some background on how the platform manages capacity.
Rationale
Readers scan, so front-loading the key point means they get it even if they do not read on.