Documentation

I ran a live stream a while back where I looked at new features in

I won’t repeat any famous phrases about how pictures equalling a quantity of words, I think we all understand the potential power of a good visual. Well considered images in documentation can help illustrate a concept, clarify a complex idea, or show a reader what they can expect from undertaking certain steps.

When comparing products, you want to decide on their usefulness. Yet, we often forget to evaluate the project's documentation. A project might offer an excellent set of features but might lack easy-to-use documentation. This can have a detrimental effect on the developer experience and your team's efficiency. So, how do you evaluate the developer experience of documentation?

API documentation is generally predictable, follows common patterns, and is one of the least interesting tasks in a documentation project. It's also a task with a degree of pre-existing automatic generation tools and practices. It sounds like a perfect use case for AI-assistive tools! In this post, I look at general and specialized tools for generating API documentation from code and text-based prompts. I also cover potential problems and pitfalls in generated docs and how to test the generated output to ensure its accuracy.