Documentation Audit Example

The slide deck above is an example of a full documentation audit.

A documentation audit includes a complete evaluation of API reference material and developer portal information. Many recommendations applied to the complete set of documentation, such as checking the readability score of long sentences and establishing an internal style guide to maintain consistent terminology.

Other recommendations are more specific, such as removing duplicate content in a tutorial. Each recommendation includes a screenshot along with a written explanation and suggested solution.

Please click through to explore and, as always, reach out with any questions!