documentation Archives

Development Practices

A Checklist for Documenting Your Public-Facing API

Here, I'll walk through the different forms of public-facing API documentation and developer tools that we added at different phases of the project.

TypeScript

Automate API Documentation and TypeScript Types with OpenAPI

Recently I was tasked with updating the API documentation on a project to OpenAPI format. Here's how to get started using it in your project.

Developer Tools

Create Easy GraphQL API Documentation with SpectaQL and GitLab Pages

Easily generate a GraphQL API documentation site based on your annotated GraphQL Schema using GraphQL docstrings, SpectaQL, and GitLab Pages.

Growing as Makers

Document Your Process to Teach and Learn a New Task Well

One thing that’s helped me teach and learn new tasks is our team’s emphasis on documentation and a defined way to pass along process.

Project & Team Management

A 4-step Checklist for Transitioning to a New Job

When transitioning to a new job, it can be easy to get caught up in excitement about the new position. Here are four ways to prepare for your departure.

Development Practices

Document All the Things Before Handing Off a Maintenance Project

Before handing off a maintenance project, here are items you should document or get from the client or the previous person who worked on it.

Development Practices

Better Documentation Through Low-Fidelity Diagrams

Low-fidelity diagrams generate more accurately documented systems than complex master diagrams. Here's how I use them on software projects.

Project & Team Management

Three Levels of Software Project Closeout Documentation

Everyone wants more project documentation, but nobody wants to write it. Make the most of your time by only creating the documentation you really need.

Development Practices

Four Tips for Dealing with Poorly Documented Libraries

Tackling poorly documented code libraries can be a hassle. When in doubt, glean as much information as you can and piece together a strategy.

Development Practices

Using Cookbook Documentation to Pass on Knowledge

Cookbook documentation organizes material into "recipes," simple practical problems along with a described solution and short code sample.

Development Practices

Sticky Documentation, Part 2: Source Control History as Documentation

How to make the most of documentation that "sticks" close to an application through its lifecycle—source control history.

Development Practices

Framework Docs Are a First-Class Citizen

Documenting your framework code is crucial to its success. I recommend Documentation Driven Development (DDD).