GPDoc logoGPDoc
Solutions
Developer advocates & customer educationMaintain reusable technical lessons

Developer education playbooks

Build reviewable lessons from documents, slides, browser notebooks, code, diagrams, and published pages without splitting the source across separate authoring tools.

Build a lesson set

Where training content drifts

  • Documents, slides, notebooks, and code examples are updated on different schedules.
  • A product change can leave the explanation and runnable example out of sync.
  • Reviewer feedback is difficult to trace when it arrives outside the source file.

What GPDoc supports

  • Documents for lessons, setup guides, and reference material in Markdown.
  • Slides for instructor-led sessions and recorded walkthroughs.
  • Notebooks that combine explanation with Python, JavaScript, or TypeScript cells.
  • Code, LaTeX math, tables, and Mermaid diagrams close to the technical explanation.
  • Review through comments, suggestions, version checkpoints, and Git workflows where supported.
  • Export and publishing to supported HTML, PDF, Markdown, LaTeX, PowerPoint, Word, .ipynb, and static-site destinations.

Keep the lesson source open

Use one reviewed source set for the lesson, presentation, and exercise. Export a destination copy only after the explanation and example have been tested together.

Suggested workflow

Create a document for the learning objective and setup, a slide deck for instruction, and a notebook or script for the runnable example.

Put commands, code, expected output, diagrams, and caveats next to the step they explain. Use links between files when the lesson spans several source types.

Ask a reviewer to follow the lesson from a clean environment. Capture questions in comments and proposed wording or code changes as suggestions.

Create the formats required for the workshop or course. Publish supported HTML output as a site when learners need an easy-to-share web destination.

Apply confirmed fixes to the GPDoc files, rerun examples, and create new destination copies. Keep the prior revision available through file history or Git.

What to check before delivery

  • Every command and code sample runs in the stated environment.
  • The document, slides, and notebook use the same product names and version details.
  • Exported files open correctly on the devices learners will use.
  • Published pages contain no credentials, private repository paths, or restricted data.

See the browser notebook workflow, or review publishing and exports.

Related solutions