liveBook · Manning

List

As explained in Writing for Developers: Blogs that get read

A list is a structured sequence of related items presented as separate entries in written content.

Use a list when a paragraph is really a set of related items. Choose numbered entries when order or priority matters; otherwise choose bullets. Keep every item parallel by starting it in the same way. section 5.5.2

Apply this quick test:

  • Number steps that must be processed sequentially. section 5.5.2
  • Number a prioritized set of items. section 5.5.2
  • Use bullets for related items without meaningful order. section 5.5.2
  • Check complex or multilevel lists in rendered HTML and adjust them when necessary. section 7.3.6

A useful resource list

For a rewrite, list each resource as a bullet and add a sentence explaining why it helped or failed. The commentary turns a bare inventory into a navigation aid. section 9.5.4

How Writing for Developers: Blogs that get read covers it

How deep it goes
Explains selection, parallel structure, and rendering checks, but stops short of detailed HTML implementation.
Examples
Uses sequential steps, prioritized items, unordered resources, and complex multilevel lists as examples.
What it assumes
Distinguishes related items and whether their order matters; treats paragraph-to-list conversion as the starting decision.
What you can do after
Evaluate and revise list structure for ordering, parallelism, readability, and rendered HTML behavior.
How it connects
Connects lists with paragraphs, tables, headings, and HTML rendering.

Related concepts

This explainer was generated by Manning's knowledge graph from the text of Writing for Developers: Blogs that get read. The section links point to the parts of the book it draws on.