1. apidoc
2. documenting APIs
3. Testing API documentation

Testing API documentation

Testing your documentation is critical to providing accurate, thorough information. With API and developer docs, due to the high level of complexity and engineering requirements, technical writers might be inclined to simply take information that engineers give them and incorporate it wholesale, without personally testing it. Merely playing an editorial/publishing function, however, can reduce your role to that of an engineer’s secretary.

Sections in this chapter:

• Overview of testing your docs
• Set up a test environment
• Test all instructions yourself
• Test your assumptions
• Activity: Test your project's documentation