Module user guide

Alongside the code, every generation writes a plain-language guide explaining what the module does and how to use it — for whoever ends up running it day to day, not for a developer reading the source. This page covers where to read that guide and how to get a copy. For the archive it ships inside, see downloading a module.

Right after a generation finishes

The completion screen (see generating your first module) has a User Guide section. Open it to read the guide inline, and use the copy button in its header to copy the raw text — handy for pasting into a wiki or ticket without downloading anything first.

From the Modules Library, as a PDF

Open a module’s card in the Modules Library and click Guide (PDF), next to the Download button. This renders the guide as a branded PDF and downloads it as <module name>_user_guide_<language>.pdf.

Note

The Guide (PDF) button only appears once a module has both a guide and an archive to render it from. A module generated before this stopped ships without a guide, and if a module’s ZIP has expired under the 90-day retention described in downloading a module, the button drops even for a module that had one — there’s nothing left to render it from.

Multiple languages

If you asked for translations when configuring the run, OdoMate writes an extra copy of the guide for each language, alongside the English original, which is always written regardless of what you picked. The PDF you download from the Modules Library matches your current interface language, falling back to English when the guide wasn’t translated into it — it does not ask you to pick a language separately.

The inline guide on the completion screen is always the English version, straight from the run that just finished; only the PDF you download later reflects your interface language.