Course Objective & Scope
Technical documentation is either never written or goes stale weeks after release, while naive 'document this file' prompts produce verbose prose that merely restates the code. This course teaches a Docs-as-Code workflow that generates concise, high-value documentation anchored directly to the repository.
Generating C4 and Mermaid architecture/sequence diagrams from code, writing Architecture Decision Records (ADRs), producing OpenAPI/AsyncAPI references with verified code samples, authoring developer onboarding guides and operational runbooks, and catching documentation drift during PR review are practised hands-on.
Who Should Attend?
- Software engineers, tech leads and software architects
- Technical writers and Developer Relations (DevRel) specialists
- Systems/business analysts and platform engineers
- Prerequisite: basic familiarity with Git, Markdown and software repository layouts
Key Takeaways
- Author ADRs and architecture overviews that explain design rationale ('why') rather than repeating syntax ('what')
- Turn service topologies, data flows and state machines into maintainable Mermaid and C4 diagrams
- Produce accurate OpenAPI specs and SDK guides backed by tested code snippets
- Create verified local-setup and onboarding guides for new team members
- Detect documentation drift automatically whenever related code changes in a pull request
Curriculum
Docs-as-Code Principles and High-Signal Writing
- Avoiding verbose AI filler: matching doc types to audiences (engineers, integrators, SREs)
- In-repo Markdown layout, templates and versioning alongside code
Visualising Architecture: Mermaid and C4 Diagrams from Code
- Generating sequence, ER and C4 context/container diagrams from routes, events and dependencies
- Capturing design trade-offs in crisp Architecture Decision Records (ADRs)
API Reference, Schemas and Integrator Guides
- Enriching OpenAPI/Swagger, GraphQL and webhook specs from code and type definitions
- Embedding tested request/response examples that never silently break
Developer Onboarding Guides and Operational Runbooks
- Codebase tour, local environment setup and troubleshooting guides
- Service alerts, environment variables and incident response runbooks
Preventing Documentation Drift in CI and PRs
- Automated PR checks that flag READMEs or API docs affected by code diffs
- Linting for broken links, invalid Mermaid syntax and terminology consistency
Other Courses in This Category
-
Advanced training on repository-scale context engineering for monorepos and large codebases: AST indexing, hybrid search, dependency graphs, hierarchical AGENTS.md/CLAUDE.md files and context-window budgeting.
- Live Course
- 5 modules
-
Detecting OWASP Top 10 flaws, broken access control, hallucinated packages (slopsquatting), leaked secrets and insecure defaults in AI- and human-written code using SAST (Semgrep, CodeQL) and LLM-assisted security review.
- Live Course
- 5 modules
-
Governance training for engineering organisations covering zero-data-retention (ZDR), IP and open-source licence compliance, approved model/MCP registries, risk tiering and developer policies for AI-assisted coding.
- Live Course
- 5 modules
-
End-to-end training on redesigning the Software Development Life Cycle for the AI era—resolving review, QA and security bottlenecks across requirements, coding, PR review, CI/CD and operations, with DORA/SPACE metrics.
- Live Course
- 5 modules
-
Extracting business rules from COBOL, PL/SQL stored procedures and legacy Java/.NET monoliths, applying the Strangler Fig pattern, verifying parity with golden-master/dual-run tests and migrating safely to modern architectures.
- Live Course
- 5 modules
-
Training for QA and test engineers on testing non-deterministic LLM, RAG and agent applications using golden datasets, RAG evaluation metrics, LLM-as-a-Judge, prompt-injection red teaming and CI regression gates.
- Live Course
- 5 modules
Get in touch
