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

Scoping and requirements gathering

Within a company or project, documentation requests can come from a variety of internal and external sources, including the following:

  • A new feature that’s in progress, probably from a product owner
  • A new feature that’s already been completed that needs documentation
  • A feature gap that’s been identified by you or others
  • A content gap that’s been identified by you or others
  • A problem that’s been logged by you or others

When you start filling that content need, the first step is to figure out the current definition of done. I say “current” as just because there may be a completion point for the content needed now doesn’t mean it will remain that way forever. Likely, it will not be considered done in the future. However, while there are predictable potential future changes, there are also others that aren't, and finishing the work as completely as possible now...

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}