Reader small image

You're reading from  Technical Writing for Software Developers

Product typeBook
Published inMar 2024
PublisherPackt
ISBN-139781835080405
Edition1st Edition
Right arrow
Author (1)
Chris Chinchilla
Chris Chinchilla
author image
Chris Chinchilla

Chris Chinchilla spent years as a developer before switching to helping people understand code better instead of writing it. He has worked crafting documentation for many developer-focused projects, from small open-source projects to large and well-known tools and products, tackling everything from tooling to videos. He is known for bringing developers and writers closer with editor and automation-based tools. Outside of tech writing, he publishes fiction, YouTube videos, podcasts, and music. In short, he loves to communicate and find the best medium for the message.
Read more about Chris Chinchilla

Right arrow

Thinking about pages semantically

Any web page – in fact, most pages in any format – begin with a title or heading. Regarding HTML, this should be an <h1></h1> heading or heading level 1. Every page should have only one h1, but unfortunately, many tools and people break this rule to the page’s detriment.

Typically, right after an h1 is some opening text, and then every following subheading should be an h2. Then, every subheading underneath is an h2, an h3, and so on. Most browsers comfortably handle everything down to an h5, and theoretically, you could keep going further down the levels. However, if you have that many subheadings, your content probably needs reorganizing.

Break up paragraphs as much as possible by a group of topics or a few sentences at a time. Don’t fear whitespace. It helps people read and guide their eyes around a page. This is the same with subheadings. They break up the wall of text and draw people’s eyes to...

lock icon
The rest of the page is locked
Previous PageNext Page
You have been reading a chapter from
Technical Writing for Software Developers
Published in: Mar 2024Publisher: PacktISBN-13: 9781835080405

Author (1)

author image
Chris Chinchilla

Chris Chinchilla spent years as a developer before switching to helping people understand code better instead of writing it. He has worked crafting documentation for many developer-focused projects, from small open-source projects to large and well-known tools and products, tackling everything from tooling to videos. He is known for bringing developers and writers closer with editor and automation-based tools. Outside of tech writing, he publishes fiction, YouTube videos, podcasts, and music. In short, he loves to communicate and find the best medium for the message.
Read more about Chris Chinchilla