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.
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.
Easily generate a GraphQL API documentation site based on your annotated GraphQL Schema using GraphQL docstrings, SpectaQL, and GitLab Pages.
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.
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.
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.
Low-fidelity diagrams generate more accurately documented systems than complex master diagrams. Here's how I use them on software projects.
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.
Tackling poorly documented code libraries can be a hassle. When in doubt, glean as much information as you can and piece together a strategy.
Cookbook documentation organizes material into "recipes," simple practical problems along with a described solution and short code sample.
How to make the most of documentation that "sticks" close to an application through its lifecycle—source control history.
Documenting your framework code is crucial to its success. I recommend Documentation Driven Development (DDD).