Skip to Content
Technical Writing for Software Developers
book

Technical Writing for Software Developers

by Chris Chinchilla
March 2024
Intermediate to advanced
166 pages
4h 27m
English
Packt Publishing
Content preview from Technical Writing for Software Developers

4

Page Structure and How It Aids Reading

Chapter 3 covered crafting better words to help people understand what you want to explain. Have you ever attempted to read and understand something complex to be faced with a solid wall of text that’s hard to parse to the point where your eyes stop processing any potentially fantastic information?

Crafting the perfect words is a waste of time if you make it extremely hard for anyone to read them. Thankfully, the principles of good layout for print and web-based output are well established, and documentarians can learn much from them to improve their content layout. In addition to these time-honored principles, there are a couple of other documentation and technical writing-specific tips worth considering, ...

Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.

Read now

Unlock full access

More than 5,000 organizations count on O’Reilly

AirBnbBlueOriginElectronic ArtsHomeDepotNasdaqRakutenTata Consultancy Services

QuotationMarkO’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.
Julian F.
Head of Cybersecurity
QuotationMarkI wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.
Addison B.
Field Engineer
QuotationMarkI’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.
Amir M.
Data Platform Tech Lead
QuotationMarkI'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.
Mark W.
Embedded Software Engineer

You might also like

Technical Writing, 2nd Edition

Technical Writing, 2nd Edition

Phillip A. Laplante
Writing for Developers

Writing for Developers

Piotr Sarna, Cynthia Dunlop

Publisher Resources

ISBN: 9781835080405