Search results

Testing API documentation

Last updated: May 28, 2023

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.

Download a PDF of this section.

Buy me a coffeeBuy me a coffee
60% Complete

60/162 pages complete. Only 102 more pages to go.