Here we present topics to work on for the user documentation:

  1. Overview pages.
  2. Schema.org structured data.
  3. Custom Fields.
  4. A tutorial about content management with Joomla.
  5. How-to guides with mod_articles
  6. Tutorial: Add a module to the Dashboard
  7. Template overrides.
  8. Joomla 5 articles in the wiki, not yet in this user manual
  9. Useful Magazine Articles

 

Overview pages

A principle in documentation is to always give an overview when you have nested menu-items. See https://diataxis.fr/complex-hierarchies/ for an explanation (there thet talk about "landing pages" or "content pages", but the idea is the same). When you look at our current user manual, you see a lot of "headers" that expand to show the menu-items under it. But those current headers themselves don't refer to a page. This should be pages that give an overview of what is in them at the moment.

In our current user manual we should have an overview page for "User Manual", "Getting Started", "Articles" etc. showing what you can find in the underlaying articles. This is also a great way to become acquainted with the current user manual, for you have to look what is in the undelying pages.

Please keep in mind that we are restructuring the content. So the current headings may change. One of the changes will be a clustering of pages around the following themes:

  • Content Management with Joomla (creating, updating and publishing articles, categories, menu-items, etc)
  • Maintaining a Joomla site (updates, backups, user management, etc)
  • Building a Joomla site (installing Joomla, templates & design, extensions, etc)

 

Schema.org structured data

This is missing at the moment in the user manual. In Joomla since version 5.1.

What we need most:

  • a tutorial explaining the basics of structured data and the schema.org implementation in Joomla
  • guides how to configure the existing plugins
  • a tutorial how to make a new schema-plugin (this is halfway the user manual and the developer manual)

Background material:

 

Custom Fields

Needed:

  • a tutorial explaning how to use custom fields; now: https://docs-core.sandbox.joomla.org/user-manual/fields/fields-fields-and-field-groups
  • Of all the articles currently under "fields" there are 4 general articles (fields and field groups, field parameters, multilingual sites, and template overrides). They are on the same level with the 15 types of custom fields and one article about a special custom field: subform. Can you come up with a better structure instead of putting all those articles on the same level? if you need a deeper layer, don't forget the overview page.
  • a how-to guide about how to repeat custom fields (using a subform).
  • example of using nested subforms in custom fields (new since 5.2).
  • a reference (overview) of all custom fields + short description.
  • tutorial about template overrides. see https://docs-core.sandbox.joomla.org/user-manual/fields/fields-adding-custom-fields-overrides

See the series about custom fields by Marc Dechèvre in the Magazine:

 Is there anything in those articles that should be in the documentation?

 

Tutorials about content management

  • a series of tutorials that shows beginners how articles, menus and categories play together in Joomla.
  • in the current user manual those topics are scattered under several headings (getting started, articles, menus). We especially need some articles that show the relation between the several parts. For instance you can set some general values in the articles options, but you can also set those values in the options-tab of an article or of a menu-item. In addition, you can also adjust the settings in the settings of a category.
  • we are restructuring the content of the manual: now it is mainly an alphabetical listing, but we want to put things that belong together more together. All those things about articles, menu's and categories will be under one heading of Content management.

 

How-to guides with mod_articles

Also: update https://docs-core.sandbox.joomla.org/user-manual/modules/modules-site-modules for mod_articles.

Tutorial: Add a module to the Dashboard

 

 

Template overrides and alternate view templates

 

Joomla 5 articles in the wiki, not yet in this user manual

As far as not yet mentioned above.

 Useful Magazine Articles

Some of these can be used as base for a documentation article.

 

Move to Developers Manual To-do List