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

Welcome, wordsmiths!

Before I begin, I’d like to start where I always like to begin, with some history.

My grandfather worked for a long-since-acquired company that created and laid submarine cables, the long and large network of cables lurking under the sea that enable communications between countries worldwide. When he laid them from the back of the large ships that ran between the UK and Canada, he was laying gigantic reams of copper wires mostly meant for telephone and telegram traffic. By the time he retired, the internet existed in some rudimentary form, telephones were widespread, and he gave me a nugget of advice that I still remember today, despite being too young to really understand what he meant:

“Optic fibers are the future.”

And he was right. Now, there are more submarine cables than ever, shuttling petabytes of data back and forth per day. Our work and play rely so much on a relatively small amount of vulnerable wires that rest on the ocean bed, are prone to damage and attack, and have disconnected smaller nations from the world.

I digress. Why am I telling you this in a book about tech writing?

My grandfather started his professional career as a technical artist. He drew up plans and instructions on how to make and lay these essential cables, plus how to use the machinery needed for the task. I can’t imagine he ever anticipated much of the work you and I do now (he died in 2001), but I could imagine that he would be amused that we ended up in related careers and fascinated by some of the projects I have worked on.

My point is that if we consider “technical writing” to mean explaining something to someone else so they can understand it and how to use it to accomplish their goals, then “technical writing” is everywhere.

lock icon The rest of the chapter is locked
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