documentation

I am a big believer in good documentation being an essential part of the product. Good docs are hard to come by for several reasons, not the least being the fact that writing good docs is hard.

How to write API documentation that nobody can use, read, or use as reference.

A demo application that shows you how to generate Python API documentation without worrying about complex configuration.

When building documentation for your product, you will often encounter situations where you need to mix and match a bunch of content that comes from different sources.

A short guide that shows you how to generate Java API documentation with open-source tooling.

How to publish documentation with DocFX and GitHub Actions.

I outline the merits of structured content in maintaining a sustainable content strategy.

How to generate documentation for Python and Node.js APIs with DocFX.

How to generate and host your documentation in the cloud.

Learn how to start using DocFX to generate and publish documentation.