Diátaxis, a new foundation for Canonical documentation

See the full post here ➡️ https://ubuntu.com//blog/diataxis-a-new-foundation-for-canonical-documentation

Excerpt below:

Our on-going documentation transformation project aims to make our documentation the best it can possibly be – an exemplar of excellence for the industry. We’re working on four distinct pillars of documentation to achieve this. The first of these pillars is direction. It defines what is quality in documentation, and answers the question: what makes documentation good?

The principle that guides us in this is simple: good documentation serves the needs of its users. We are adopting the Diátaxis documentation framework to help us put this principle into practice.

Our direction

The Diátaxis framework is a light-weight and pragmatic approach to meeting users’ needs in a systematic way, by prescribing a core structure for technical documentation. It provides standards, and a methodology to guide us – it’s a map and a compass.

Direction is a good metaphor for our work in documentation. When you’re going somewhere, you need to have a clear idea of where you’re headed, even if you don’t necessarily know precisely what the final destination is. If you’re charting new territory, there might not even be a final destination. When you can’t plan the whole journey in advance you need to be prepared to adjust for changing circumstances and what you find along the way.

Still, your intended direction should be clear. At any given moment you need to be able to know which way you’re actually facing, and where you are. You need to know what’s between you

...


Click >>> here <<< to share your news for free!

About Linux Chatter

Linux Chatter is a news aggregator service that curates some of the best Linux, Cloud, Technical Guides, Hardware, and Security news. We display just enough content from the original post to spark your interest. If you like the topic, click on the 'read full post' button to visit the author's website. Then, use Linux Chatter to find content from amazing authors!

Why should you share your news?

Contributing is one of the best ways to promote a website. This technique has been used for decades now and is still very effective. But, this strategy can make or break your rankings depending on its application.

A news website is one of the best places to publish your blog. This is because such sites always have massive amounts of targeted traffic. If you write quality content, your post will get lots of hits, and many people will follow your blog.

Disclaimer

The content provided has been modified and is not displayed as intended by the author. Any trademarks, copyrights, and rights remain with the source. Linux Chatter sources content from RSS feeds and personal content submissions. The views and opinions expressed in these articles are those of the authors and do not necessarily reflect Linux Chatter.