Single-source generator: author content once in the block DSL; it emits both
LEARNER-GUIDE.md (repo root) and courseware/<course> Learner Guide.docx.
Template: make_learner_guide.py (uses prodoc.py).
How to use
- Edit
make_learner_guide.py: setREPO,TITLE,VERSION,VERSIONS, and the content blocksB. - Use the helpers:
h1/h2/h3,p,steps,bullets,code,table,note,rule, plus("img", path, caption)for workflow screenshots. - Run
python3 make_learner_guide.py. The MD and DOCX are generated from the sameB, so they stay aligned. - Each activity should embed its workflow screenshot right after the "Goal" section (the generator does this via
insert_images).
Content rules
- Detailed step-by-step for every activity (numbered
steps), a Goal, a What you'll build node flow, and a Test it box. - A
0. Before You Startsetup section: accounts/API keys table, run-n8n (cloud + local Docker), credentials, and a GitHub download link for the workflows. - A Troubleshooting cheat-sheet and a Glossary table.
- Keep the MD and DOCX content identical (single source).
House format — Tertiary Infotech Academy Pte Ltd (WSQ)
Every generated document/deck MUST include:
- Cover page with: the Course Title; the n8n course logo and the Tertiary Infotech Academy Pte Ltd logo;
WSQ Course Code: TGS-XXXX;Conducted by Tertiary Infotech Academy Pte Ltd;UEN: 201200696W; and a Version number. (Logos live incourseware/assets/:tertiary-infotech-logo.png,n8n-course-logo.png.) - Document Version Control Record table — columns: Version Number | Effective Date of Release | Summary of Included Changes | Author.
- Table of Contents — a Word TOC field that auto-updates (headings use the built-in Heading 1/2 styles;
updateFieldsis enabled so Word refreshes it on open). - Footer on every page — the copyright line
© 2026 Tertiary Infotech Academy Pte Ltd. All rights reserved.and Page X of Y numbering. The footer URL is www.tertiarycourses.com.sg. - Font: Arial, 11 pt body; headings in Arial bold.
- Brand colours: blue
#1F6FEB, teal#10B981, ink#161B26, grey#5B6372.
The reusable helper prodoc.py implements the cover page, version-control table, TOC field, page numbering and copyright footer — import it and call add_cover_page, add_version_control, add_toc, add_page_numbers, enable_update_fields, style_headings.