This is another post in my series on testing documentation.
Testing your docs is one of the great principles of technical writing. Not only does testing all aspects of your documentation help you discover missing or inaccurate steps, it also lets you discover bugs, make recommendations for improving the product, and helps you be a power player on the team.
In some brief Twitter responses to my previous posts on testing docs, a couple of people said:
If there are tech writers who don’t do this, if testing isn’t part of their DNA, how are they still getting paid? https://t.co/pPrup6aLr8— Chuck Martin (@chuck_martin) July 7, 2015
It's a key to getting a job. I won't hire a writer if they don't test their docs. https://t.co/aCjogtbGdE— Neal Kaplan (@NealKaplan) July 7, 2015
I guess testing isn’t such a fascinating idea in most people’s eyes. It’s more like, Duh, of course technical writers should test all their documentation. You mean you’re not????
And while I agree, I also think the ease of testing depends on how technical the content is. When I was working in GUI documentation, testing everything was the norm, because no one ever supplied any content for me, and test scenarios were easy to set up and execute.
With API and developer documentation, though, it’s a different story. The content is more complicated, and sometimes it’s written by engineers and submitted through technical writers for editing, clarity, polish, and publishing — but not always authoring.
When technical writers start functioning as editors/curators/publishers more than authors, it’s easy for testing to get overlooked. For example, if an engineer writes up instructions on how to install mod_fastcgi on a Red Hat Enterprise Linux server, do you say wait a minute there, pal. Let me walk through all of these Red Hat steps and see how accurate they are? Or do you just edit the content for clarity and publish?
Ideally, you’d say the former — and pause everything until you’ve run through all the steps. But there’s a certain level that’s not documented. In this case, it’s the setup of Red Hat Linux itself. To test the instructions, you’d first have to install Red Hat Enterprise Linux on a server, and then you download and install the necessary mod_fastcgi packages.
You can certainly do this, but there’s usually an assumption that the user already has Red Hat set up on their system, or else they wouldn’t need to know anything about mod_fastcgi. As a technical writer, to test instructions, a lot of times you have to do some initial setup that the user is already assumed to have done.
Here’s another example. Let’s say you have some API functions for a C# API. To test them, you’d need to install a virtual machine on your Mac (through something like Fusionware), get a Windows OS license, enable IIS, install Visual Studio, and build a sample .NET app to first generate data. Only then can you start to test the API calls — assuming you know enough about C# to make a valid application.
Can you see how in these scenarios, testing documentation is not such an easy task?
Here’s another example. Let’s say you’re documenting how to set up an Amazon Web Services (AWS) server environment. The server architecture involves Rabbit MQ, Postgres RSD, Aerospike, Tableau, EMR, data policies in S3, and about 5 other technologies you’ve never heard of. The documentation is for an IT Operations team. How do you really test all of this if you’ve never worked with any of these technologies before? How do you even download what you need to run through step 1?
In this scenario, testing the actual steps of the architecture deployment is a huge undertaking. If you’re just editing, though, you could do it in an afternoon. Again, though, if you just edit the content, the accuracy and completeness will likely be poor.
Fortunately, in any developer environment, there is almost always a QA team. And the QA team no doubt has written a test app that allows you to easily implement the functions you need in a sample application. Many times QA team members are more accessible and understanding than engineers, who usually feel the world isn’t smart enough for them.
Many companies also include reference or simple applications with the code they distribute. These reference applications might show how to activate the license and call the API with various methods. These kinds of sample applications are extremely helpful in getting set up because they already contain full examples of working code.
Another comforting fact is that with tech writing, knowledge of technologies must be wide but not necessarily deep. For example, for our Java API, I was able to install Tomcat, deploy a couple of web apps, and follow the Java code in our sample reference app (which is a JSP page). I knew just enough about each technology to scrape by. But if I had to do more complicated tasks, such as code the reference implementation from scratch myself, I would have a tough time.
Overall, developers and QA usually understand that technical writers aren’t programmers. If you ask the team for help, they can usually help set up your system with a basic implementation so you can move forward with the testing that you need to do.
You could also research the tasks on your own and figure out how to set up the technology. Many times the setup isn’t nearly as hard as it seems.
However, make no mistake. Testing docs that are extremely complex is going to be tough. The easy route is just to edit the content and get engineers to sign off on the accuracy. But without testing the instructions yourself, there will no doubt be gaps and errors, as there always is with untested instructions.
If it’s really impractical to test things yourself, you can try to get target users to test the content and give you feedback. This is the sort of user testing you should do anyway. However, unless you get a lot of feedback, the users who test the instructions might be advanced users to begin with (and therefore may be skipping around in the instructions), or they may only glance through the instructions rather than really doing all of the steps.
Even if it takes a long time to set things up initially, the setup will usually serve you well in the long run, because you’ll be able to better understand the material, make and run your own experiments, and learn how to do things yourself. This foundation will greatly simplify documentation efforts in the future, and your role as a tech writer won’t merely be that of a scribe.
Get new posts delivered straight to your inbox.
I'm a technical writer based in the California San Francisco Bay area. Topics I write about on this blog include technical writing, authoring and publishing tools, API documentation, tech comm trends, visual communication, technical writing career advice, information architecture and findability, developer documentation, and more. If you're a professional or aspiring technical writer, be sure to subscribe to email updates using the form above. You can learn more about me here.