Website Documentation

Site Documentation lets the people who run a website write the guides for running it, in the admin interface, without a developer and without a deploy.

Every site ends up needing this. How do we add a staff member? Where do the opening hours live? What do we do when a form stops sending email? The answers usually end up in a shared document nobody can find, in an email thread, or in the head of the person who built the site. This module keeps them in the site itself, next to the work.

How this differs from the help system in core

Core's help system, and the file based modules around it, are written by developers: a topic is a Twig or Markdown file inside a module, so changing one sentence means a code change and a deployment. This module is the other way round. A guide is content. An editor writes it in the admin interface, attaches screenshots, saves, and it is live. That matters most at handover, when the people who now own the site are the ones who need to write things down.

What you get

• Guides written and edited in the admin interface, with screenshots that open full size and file attachments such as PDFs or checklists.
• Per guide role restrictions. Leave it open to everyone with the view permission, or name the roles that may read it.
• A documentation list grouped by type, filterable by type and audience, with a link in the toolbar.
• Optional context on each guide: who it is for, the topics it covers, a difficulty level and how many minutes the task takes.
• Guides can be switched off while they are being rewritten. They stay visible to the people who edit documentation and disappear for everyone else.
• Six permissions, so reading, writing, deleting and managing role access can go to different people.