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

Helping less technical writers with headless CMS

Earlier in this chapter, I mentioned other common methods for creating documentation outside of the docs as code practice, such as using a CMS or wiki. There is a middle ground that’s quickly worth mentioning: headless CMS. This method is especially useful for those in mixed teams with other team members who might struggle using text editors, markdown, and version control. Instead, you can mix both, using a CMS to create and maintain content workflow and markdown files. The CMS outputs content as JSON APIs that you can consume in frontend applications to render the content.

Many of the tools in the headless CMS world are commercial, such as Contentful (https://www.contentful.com/) and DatoCMS (https://www.datocms.com), but there are a handful of open source options, such as Strapi (https://strapi.io/) and Ghost (https://ghost.org), and even traditional CMS that often have some headless mode these days. I am unsure how popular...

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}