Reader small image

You're reading from  Technical Writing for Software Developers

Product typeBook
Published inMar 2024
PublisherPackt
ISBN-139781835080405
Edition1st Edition
Right arrow
Author (1)
Chris Chinchilla
Chris Chinchilla
author image
Chris Chinchilla

Chris Chinchilla spent years as a developer before switching to helping people understand code better instead of writing it. He has worked crafting documentation for many developer-focused projects, from small open-source projects to large and well-known tools and products, tackling everything from tooling to videos. He is known for bringing developers and writers closer with editor and automation-based tools. Outside of tech writing, he publishes fiction, YouTube videos, podcasts, and music. In short, he loves to communicate and find the best medium for the message.
Read more about Chris Chinchilla

Right arrow

Summary

OK! That was a lot of information and barely scratched the surface of all the options available. Hopefully, you can see that the wide world of documentation tooling, while not quite as wide as developer tooling, offers a lot of options to suit almost all tastes and requirements.

This chapter covered the essential tools you need for using the docs as code methodology while also looking closely at two of the other popular methodologies many documentarians use.

If you want to find more options, take a look at this awesome list for documentation tooling: https://testthedocs.github.io/awesome-docs/.

Those essential tools for docs as code are as follows:

  • A text editor to write in
  • A markup language to use
  • A way of collaborating with others
  • A way to render the documentation you write
  • Methods for assessing how useful readers find the documentation

I also covered important topics related to these tools, such as metadata, newer markup language options...

lock icon
The rest of the page is locked
Previous PageNext Chapter
You have been reading a chapter from
Technical Writing for Software Developers
Published in: Mar 2024Publisher: PacktISBN-13: 9781835080405

Author (1)

author image
Chris Chinchilla

Chris Chinchilla spent years as a developer before switching to helping people understand code better instead of writing it. He has worked crafting documentation for many developer-focused projects, from small open-source projects to large and well-known tools and products, tackling everything from tooling to videos. He is known for bringing developers and writers closer with editor and automation-based tools. Outside of tech writing, he publishes fiction, YouTube videos, podcasts, and music. In short, he loves to communicate and find the best medium for the message.
Read more about Chris Chinchilla