Technical Writer Playbook

Documenting an API is crucial to its success but can be extremely time consuming. Here at Stoplight, we believe documentation should be beautiful, clean, and robust while maintaining a streamlined turnaround time. We’ve created a holistic documentation tool, Hubs, to address some of the problems our users were facing including:

  • Documenting Endpoints
  • Testing Endpoints
  • Creating Non-Reference Documentation
  • Managing Content
  • External and Internal Referencing
  • Design and Style

Documenting Endpoints

The most key component to API Documentation are its endpoints. To that end, we created a reference builder that allows you to “power pages” with your specification as you see fit. When you power a page or subpage with your specification, the endpoints are automatically documented and styled for legibility and aesthetic design.

Testing Endpoints

Testing endpoints is a valuable tool for anyone who wants to consume your API. Users want to know that your API functions properly before they commit to using it. To address this problem, we created “Try it Out,” an HTTP Request Maker. Try it Out allows you to send HTTP Requests to your API to test out its endpoints under any number of different conditions. You can customize Try it Out with security schemes, variables, headers, queries, and it even generates code in various programming languages.

Creating Non-Reference Documentation

Great documentation is more than just API endpoints. Guides, tutorials, and other supplemental information enhance your users experience by providing them with all the information they need to access your API and your product. We broadened Hubs scope to accomodate all product documentation needs. You can easily build out your content within Blocks, a number of flexible content structures that can house a number of different forms of content including markdown, images, code snippets, and much more.

Managing Content

Organizing a complex APIs endpoints and supplemental information can be a challenging task. Some specification can have hundreds of endpoints with supplemental information throughout. To assist with organizing content, we created an overview of all your pages, subpages, and their connections called “Table of Contents”. With a bird’s eye view of your content, you can easily organize and manage your content through drag drop functionality.

External and Internal Referencing

To accomodate a larger variety of writing workflows, we expanded the capabilities of Powering a Page to allow for more files internally and externally to be referenced. You can now easily reference internal or external specifications, and Markdown, YAML, JSON, and Scenario files.

Design and Style

We wanted to create a new, beautiful, minimalistic, efficient design for less design-oriented individuals while allowing for customization. Hubs was designed to display your documentation in a neat, efficient structure, designed specifically for displaying the real beauty, your API. On the other hand, we didn’t want to stifle the creativity that goes into documentation design so we added in theming and custom CSS. We also made it easier to add navigation, different kinds of content, and a more robust search.

Related Links