From Name:
From Email:
To Name:
To Email:

Optional Message:

Design choices for organizing API reference content with other docs

from I'd Rather Be Writing

In this guest post, Derric Gilling, CEO at Moesif, explores various design choices for organizing API reference content in relation to the rest of your programming tutorials. He looks at three different strategies: (1) Centralized docs with separate API reference, (2) Centralized docs combined with API reference, and (3) Decentralized docs. The question of how to integrate API documentation into one seamless user experience — particularly when you have auto-generated outputs of API reference topics from tools such as Swagger — is a question that many technical writers regularly ask about. more

Powered by MultiBriefs
7701 Las Colinas Blvd., Ste. 800, Irving, TX 75063