Developer docs

The challenge: update and maintain developer documentation for multiple audiences. In some cases, develop entirely new architecture for new docs.

It isn’t always developers who are the audience, however. It’s ALL help content. It’s recognizing the audience and their nuanced needs. It’s being detail-oriented enough to determine what approach is best for what audience–all at a moment’s notice.

The solution:

• Continually reexamining the architecture of the docs by examining usefulness of pages and reviewing page metrics
• Regular communication with developers to determine what areas they find lacking and well supported
• Understand different audience needs and create different docs for those levels

My approach: Excellent communication with stakeholders combine with user testing to see what users need, and how all resulted in a format that addresses different users. Additionally, examining whether other tools are available for API examples, especially those that are industry-standard.