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

Writing for robots

All the technical and financial complexities and concerns aside, I think many of you reading this agree that a “docsbot” solves a lot of problems. Creating menu structures that make sense to everyone has always been a challenge for documentarians with a constantly moving definition of success. We add search on top of this to fill the gaps and hopefully allow people to find what they need. But all of this is fraught and non-ideal, as while we organize documentation around our internal ideas of the project or product and how we think people should access it, in reality, all most people want to do is find a way of answering a question they have and possibly don’t even fully understand how to ask or what the right answer is. Implemented well, the idea of a “docsbot” that can answer these questions is incredibly helpful and worth considering.

Where is the place for the humble writer in all of this change? Actually, we’re better...

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 $15.99/month. Cancel anytime}