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

What this book covers

Chapter 1, The Why, Who, and How of Technical Writing, talks about all the different stakeholders with an interest in good documentation and what it can accomplish for them.

Chapter 2, Understanding Different Types of Documentation in Software Development, explores the different documentation types that can form documentation.

Chapter 3, Language and the Fundamental Mechanics of Explaining, covers the grammar fundamentals that make documentation clearer and more confident.

Chapter 4, Page Structure and How It Aids Reading, explains how page structure makes content easier for readers.

Chapter 5, The Technical Writing Process, advises on the ideal process to follow for collaborative technical writing.

Chapter 6, Selecting the Right Tools for Efficient Documentation Creation, discusses the options and how to pick the tools to help create, collaborate, and provide documentation to readers.

Chapter 7, Handling Other Content Types for Comprehensive Documentation, explores other types of media to add to documentation that complement your words.

Chapter 8, Collaborative Workflows with Automated Documentation Processes, delves into how you can automate many common processes in creating documentation.

Chapter 9, The Opportunities to Enhance Documentation with AI Tools, talks about how the new wave of AI tools can assist and enhance documentation creation.

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