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

Documentation in the browser

While topic-based and docs as code are typically local files on a person’s computer, many teams create documentation straight into a browser. This could be via a documentation-specific content management system or a wiki-style system, where writers can create links between content items on the fly (the classic example is Wikipedia).

On the positive side, anyone with an account can contribute, and the toolchain is in place, standard, and kept up to date for all users at the same time.

On the negative side, user-installed browser extensions aside, what you’re given is what you get, you generally need to pay, and while browser tools are far more powerful than ever, integration options are limited.

Some popular options for writing documentation in the browser include the following:

  • GitBook (https://www.gitbook.com): A hybrid of docs as code and browser-based, GitBook attempts to combine many of the positives of both into a tool...
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}