The Trials and Tribulations of the API Style Guide
Technical writer at Shopify
The relationship of the resources may be complex. Organizational and product marketing considerations will dictate the content (mental models).
Casing conventions are necessary for comprehensive navigation.
Depending on your APIs, may group by area of functionality or by product marketing technology.
A devportal's content is not just transactional, it is relational. "Inconsistency in your documentation patterns slowly erodes your developers' trust, even if they don't tell you."
Writing without a style guide can cause inconsistency which can lead to losing the developers’ trust,
A model is needed, especially if your team starts to grow, and there are more writers with different levels of experience.
Style guide playbook
The software developer’s job is to ensure the API is working.
The developer evangelist and product marketer are to sell the API.
The technical writer has to ensure that the APIs are documented efficiently and consistently.