Search icon
Arrow left icon
All Products
Best Sellers
New Releases
Books
Videos
Audiobooks
Learning Hub
Newsletters
Free Learning
Arrow right icon
Technical Writing for Software Developers

You're reading from  Technical Writing for Software Developers

Product type Book
Published in Mar 2024
Publisher Packt
ISBN-13 9781835080405
Pages 166 pages
Edition 1st Edition
Languages
Author (1):
Chris Chinchilla Chris Chinchilla
Profile icon Chris Chinchilla

Table of Contents (12) Chapters

Preface 1. Chapter 1: The Why, Who, and How of Tech Writing 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

State of the industry

At the time of writing, the tech industry generally finds itself in an interesting place. The years of wild spending and tech startup valuations are behind us. The unstoppable growth of tech has slowed, and the industry can no longer do whatever it wants and expect no one to question it or everyone to accept it.

No matter what happens in the rest of the tech industry around us, one statistic glaringly remains in survey after survey of developer opinions and ecosystems. People want and need better documentation. The race to build over the past few years led to a plethora of applications that may or may not be well built, but often don’t make a lot of sense to internal or external users. There are budget cuts in the industry at the moment, and sometimes, roles outside of engineering are some of the first to go. But if you are open to learning and learning how to learn, there will be a role for you for a while.

It would be naive and dishonest of me to tell you that the industry isn’t in the midst of a massive state of change. The last chapters of this book will cover AI-based tools that have swept through everything in the past year or so. It remains to be seen if they are the game changer everyone promises or just another ride of the hype rollercoaster, but there’s no doubt that they will affect how we create and consume documentation in the medium term.

Automated tools for generating some parts of documentation have existed for a while, but the new wave of AI-powered options is definitely more powerful and nuanced than anything before. They can’t cover the complete documentation requirements yet, but they can fill many gaps and needs. With regards to the state of the industry and our role in it, even if everyone decides to replace their documentation platforms with AI-powered bots, they still need someone to write the source material that feeds the AI for a while. We may write less for direct human consumption, but we will still be writing.

lock icon The rest of the chapter is locked
Next Chapter arrow right
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 $15.99/month. Cancel anytime}