Search icon CANCEL
Subscription
0
Cart icon
Your Cart (0 item)
Close icon
You have no products in your basket yet
Arrow left icon
Explore Products
Best Sellers
New Releases
Books
Videos
Audiobooks
Learning Hub
Free Learning
Arrow right icon
Arrow up icon
GO TO TOP
Technical Writing for Software Developers

You're reading from   Technical Writing for Software Developers Enhance communication, improve collaboration, and leverage AI tools for software development

Arrow left icon
Product type Paperback
Published in Mar 2024
Publisher Packt
ISBN-13 9781835080405
Length 166 pages
Edition 1st Edition
Tools
Arrow right icon
Author (1):
Arrow left icon
Chris Chinchilla Chris Chinchilla
Author Profile Icon Chris Chinchilla
Chris Chinchilla
Arrow right icon
View More author details
Toc

Table of Contents (12) Chapters Close

Preface 1. Chapter 1: The Why, Who, and How of Tech Writing FREE CHAPTER 2. Chapter 2: Understanding Different Types of Documentation in Software Development 3. Chapter 3: Language and the Fundamental Mechanics of Explaining 4. Chapter 4: Page Structure and How It Aids Reading 5. Chapter 5: The Technical Writing Process 6. Chapter 6: Selecting the Right Tools for Efficient Documentation Creation 7. Chapter 7: Handling Other Content Types for Comprehensive Documentation 8. Chapter 8: Collaborative Workflows with Automated Documentation Processes 9. Chapter 9: Opportunities to Enhance Documentation with AI Tools 10. Index 11. Other Books You May Enjoy

The Why, Who, and How of Tech Writing

Tech writing is fundamentally about helping people understand concepts that are potentially complex or new to them. To do this effectively, before you start putting fingers to keys, you need to start by asking three key questions about your subject and the audience(s) for it. After doing this, later and more in-depth parts of the process will become clearer and easier. There are more audiences for your words than you might think, and different audiences have different expectations and needs from documentation. Understanding these will save you hours of work and countless frustrations later. Finally, to help you through those frustrating times, I hope to help you understand how important good tech writing is and what a crucial role you play, whatever the nature of your work is.

This chapter covers the following main topics:

  • Why tech writing is important
  • What documentarians can accomplish
  • How to understand who you are writing for
You have been reading a chapter from
Technical Writing for Software Developers
Published in: Mar 2024
Publisher: Packt
ISBN-13: 9781835080405
Register for a free Packt account to unlock a world of extra content!
A free Packt account unlocks extra newsletters, articles, discounted offers, and much more. Start advancing your knowledge today.
Unlock this book and the full library FREE for 7 days
Get unlimited access to 7000+ expert-authored eBooks and videos courses covering every tech area you can think of
Renews at $19.99/month. Cancel anytime
Banner background image