Whether you’re playing poker or creating developer documentation, it’s always better to have an ideal hand. In poker, the ideal hand is a royal flush. In developer documentation, there’s an equivalent ideal hand.
This notion came to our attention when one of our new star technical writers asked, “What technical documentation does Expert Support recommend for an audience of software developers? What’s the ideal documentation suite?”
The answer, of course, depends.
To answer the question the right way, we conducted an informal but extensive research project to tap the expertise of several of our senior writers and editors, as well as a few of our clients. As we gathered their input and advice, unmistakable best practices began to emerge.
You can find the results of that work in a new article in our online library here:
https://expertsupport.com/2020/02/the-ideal-documentation-suite-for-software-developers
Also, please note this article is the first in a new series we’ll be making available online and through professional development and training offerings that are now in the works. We’ll be unveiling more content and program specifics in the weeks ahead.
For now, take a look and tell us what you think of this article. Did we get this exactly right? Did we miss something? If so, please do let us know.
If you need help creating or improving your documentation suite for software developers, please let us know. Chances are we have a great tech writer becoming available and looking for a new assignment.
If this topic represents the kind of work you love, we want to hear from you here. We’re always looking for kindred spirits to join our team.
And I invite you to sign up for our email list so we can let you know about important posts and updates.