We will look at different methods to create better documentation. This can be used for the improvement of the documentation both for Joomla's core and for your own extensions.
We'll present principles, like “Accept (some) Repetition In Documentation” (ARID), while eliminating content overlap between separate sources. How to make documentation discoverable, skimmable, cumulative, structured, targeted, complete, consistent, examplary, and more.
We’ll explore the Diátaxis framework—a proven approach that separates content into four types: tutorials, how-to guides, reference material, and explanations. You'll learn how to tailor your documentation to meet diverse user needs, from newcomers seeking step-by-step instructions to advanced users needing in-depth technical insights. I'll illustrate this using concrete examples in Joomla's documentation.
Poor or outdated documentation is frustrating. By investing in structured, purpose-driven documentation, Joomla can ensure that all types of users—end-users, developers, beginners, experts, and contributors—find the information they need quickly and effectively. Excellent documentation is not just a “nice-to-have”; it is essential for Joomla’s success, usability, and... its survival.
