When software moved online, so did the documentation. Today, hosted documentation is the norm. But while the formats and delivery methods for documentation have changed, the fundamental goal of explaining software has not.
If anything, writing good documentation has become more difficult in recent years. The complexity of the information needed to support software products has increased dramatically. At the same time, the audience for documentation has grown larger and more diverse.
For many users of our software, the documentation will create their first impression of our products, our people, and our brand. And nobody likes poorly written documentation. I think we can all recount at least one experience where insufficient documentation turned us away from a product, and we never looked back.
That hurdle is even higher for your users who come from diverse cultural, geographic, and educational backgrounds. Creating a documentation experience that caters to all is better for inclusivity, better for your non-technical business counterparts, and better for the developer experience. The readers of software documentation today can be anyone.
Ensuring a good documentation experience means creating an environment where anyone can easily digest your docs. That means your documentation should be devoid of jargon and should