Archive of stories published by Doctave

How Google, Twitter, and Spotify built a culture of documentation

This post was originally published on the Doctave.com blog.

Many technical problems ultimately turn out to be people problems, and a lack of good documentation is no exception. Writing and…


Wikis don’t work for software documentation

This post was originally published on the Doctave.com blog.

If your software documentation lives in a Wiki, it’s very likely out of date and possibly actively harming your engineering team’s productivity. This is a story that…


The role of documentation in an agile world

The Agile Manifesto values “working software over comprehensive documentation”. This has led to some to believe that documentation has little value in a modern software development workflow — that’s a mistake. Let’s look at what role documentation can…


Export an OpenAPI specification from your FastAPI app

FastAPI is a modern Python web framework for building APIs. FastAPI is a great choice for building simple APIs, and it comes with built-in support for generating OpenAPI documentation.


Generating an OpenAPI/Swagger spec from a Ruby on Rails API

This post was originally published on the Doctave blog.

In this post we will go through how to generate an OpenAPI (previously Swagger) API reference from a Ruby on Rails application serving a JSON…

These were the top 10 stories published by Doctave; you can also dive into yearly archives: 2020, 2021, 2022, 2023, and 2024.

About
Doctave
The documentation platform for modern engineering teams. Publish world-class documentation your readers will love using a Git-native docs platform
More information
Tags
Editors