Enroll now

DURATION:

Online Self-paced

Study 5 hours/week to finish in 12 weeks

ACCESS

Lifetime

We’re always adding new lessons

CONTENTS:

Practical & theoretical

200+ video lessons + demos + activities + capstone project

    Request Syllabus

    Why You Should Enroll 

    Enroll in this course if you’re an engineer or software developer seeking to augment your skill set with documentation engineering proficiency, elevating your technical writing capabilities to new heights. This comprehensive course is tailored to empower students with the specialized knowledge and practical insights essential for navigating the intricate landscape of documentation engineering.

    Technical Writer HQ’s Documentation Engineering course is designed by industry experts for engineers looking to expand their documentation expertise. This course meets the unique demands of documentation specialists eager to excel at structured content creation.

    The course will arm you with practical skills in designing, managing, and troubleshooting documentation systems, enhancing your efficiency and the value of your contributions.

    Through explanations, demonstrations, and ample hands-on practice, you will not only learn about documentation engineering but also how to apply these concepts in your daily work immediately.

    Our distinct approach will bolster your technical prowess, leading to greater productivity and superior career opportunities.

     

    What You’ll Get From This Course

    • Comprehensive understanding of documentation engineering principles
    • Practical skills in creating and managing API documentation and help centers
    • Expertise in modern documentation tools and platforms through detailed demos
    • Hands-on experience with real-world documentation projects
    • Feedback from instructors on your capstone project
    • Access to a vibrant community of documentation professionals
    • Certification of completion that boosts your professional credibility

     

    Bonus Content

    We are 100% committed to adding more bonus course content over time (we love all things Documentation and Technical Writing and highly enjoy adding content!) and you’ll get free lifetime access to all future content!

     

    Recent Testimonials

    “Wow! So much knowledge in one course! 100% worth the investment.”

    – Anastasia Franzini, Software Engineer

    “The detailed demos are really helpful. I’m currently working on the capstone and rewatching them is saving me a lot of trial and error time. Thank you, Josh and Solomon!”

    – Antonio H., Developer

    “​I took this course while working as a developer in hopes of taking the next step in my career. I’ve recently been offered a job at $140k per year! I used my capstone project when they asked me for work samples.”​

    – Arthur Taylor, Software Developer

    “The capstone will make a great addition to my writing portfolio. I didn’t realize how much experience companies expect from their applicants, so having the capstone and insight from this course helps A TON as someone with only one year of full-time work experience. You guys nailed it.”

    – Edina Kremic, Project Manager

     

     

    Your Instructor

    Josh is the founder of Technical Writer HQ and Squibler, a writing software. He is considered one of the top product influencers by Product School and one of the top technical writers. He has written software tutorials, manuals, handbooks, and white papers for over eight years. He has written several books about software documentation and another book about copywriting. His work has been praised by LinkedIn’s and Facebook’s engineering team, Reuters, Inc., and Forbes.

    Josh me

    Documentation Engineering for Developers Course

    Get reimbursed for Documentation Engineering for Developers Course
    Single - Documentation Engineering for Developers Course
    Fast-track your career by becoming a Certified Documentation Engineer
    $299
    1 Certificate Program
    GET ACCESS
    • 1 Certificate Program
    • Exclusive content
    • Community & (live) events
    • 30-day money-back guarantee
    Best Investment
    SALE
    Full Access
    Become a continuous learner and stay up-to-date with in-demand tech writing skills
    $2149
    $599
    9 Certificate Programs
    GET FULL ACCESS
    • 9 Certificate Programs
    • Exclusive content
    • Community & (live) events
    • 30-day money-back guarantee
    • Personal coaching
    • Competency assessments
    Documentation Engineer

    Earn Your Certification

    Each certification is hosted on Technical Writer HQ's website ensuring its authenticity with hiring managers.

    Course Curriculum

    Section 1: Introduction to Technical Writing
    What is Technical Writing

    Start

    Benefits of Technical Writing

    Start

    Technical Writing Skill Set

    Start

    Quiz - Introduction to Technical Writing

    Start

    Section 2: Introduction to Documentation Engineering
    What is Documentation Engineering

    Start

    Who is a Documentation Engineer?

    Start

    Deep-Dive into Documentation Engineering Lifecycle

    Start

    Deep-Dive into Documentation Engineering Process

    Start

    Deep-Dive into Documentation Engineering - Tools and Technologies

    Start

    Documentation Engineering Challenges

    Start

    Documentation Engineer vs Technical Writer

    Start

    Responsibilities of a Documentation Engineer

    Start

    Skills of a Documentation Engineer

    Start

    The Daily Routine of a Documentation Engineer

    Start

    Documentation Engineering Examples

    Start

    Best Practices

    Start

    Summary

    Start

    Quiz - Introduction to Documentation Engineering

    Start

    Section 3: Planning your Documentation
    Section Overview

    Start

    Creating a Documentation Plan

    Start

    Documentation Content Types

    Start

    READMEs

    Start

    Getting Started - Documentation

    Start

    Conceptual Documentation

    Start

    Procedural Documentation

    Start

    Reference Documentation

    Start

    Planning Your Documentation

    Start

    Quiz - Planning your Documentation

    Start

    Section 4: Understanding your Audience
    Audience Analysis

    Start

    Creating a User Persona

    Start

    Exercise - Create a User Persona

    Start

    Validate User Persona

    Start

    Condensing User Research Findings

    Start

    Creating a Friction Log

    Start

    Exercise - Create a Friction Log

    Start

    Quiz - Understanding Audience

    Start

    Section 5: Adding Visual to Content
    Why use Visuals

    Start

    Using Screenshots

    Start

    Using Diagrams

    Start

    Drawing Diagrams

    Start

    Creating Videos for Technical Writing

    Start

    Reviewing visual content

    Start

    Maintaining visual content

    Start

    Visual Content Tools

    Start

    Quiz - Using Visuals in Technical Writing

    Start

    Section 6: Writing Great Technical Documentation
    Collaboration

    Start

    Research and Writing

    Start

    User Interviews

    Start

    Information Architecture

    Start

    How to Create Information Architecture

    Start

    Exercise

    Start

    Purpose Statements for Technical Writing

    Start

    Quiz - Writing Great Technical Documentation

    Start

    Section 7: Building Developer APIs
    Section Overview

    Start

    Section Overview - Introducing the Demo

    Start

    Section Overview - Swagger API Demo

    Start

    Designing Your Workflow

    Start

    Designing Your API

    Start

    Swagger - Building API Docs With Swagger

    Start

    Swagger Demo - Login Endpoint

    Start

    Swagger Demo - Register Endpoint

    Start

    Swagger Demo - Logout Endpoint

    Start

    Swagger Demo - Components in Swagger

    Start

    Swagger Demo - Get All Events

    Start

    Swagger Demo - Create an Event and Retrieve an Event

    Start

    Swagger Demo - Update and Join an Event

    Start

    Swagger Demo - Buy a Ticket

    Start

    Swagger Demo - Adding Security

    Start

    Swagger Demo - Publishing API

    Start

    Postman - Overview of Postman

    Start

    Postman - Postman Appilcation Overview

    Start

    Postman - Designing Our Workflow

    Start

    Postman - Designing Your API Docs

    Start

    Postman Demo - Documenting the Register Endpoint

    Start

    Postman Demo - Documenting Login Request

    Start

    Postman Demo - Documenting Logout Endpoint

    Start

    Postman Demo - Environments

    Start

    Postman Demo - Create an Event Docs

    Start

    Postman Demo - Get Events and Get Event Docs

    Start

    Postman Demo - Documented 3 Endpoints

    Start

    Postman Demo - Publishing Your API Docs

    Start

    Postman Demo - Importing Schema From Swagger

    Start

    Redoc - Designing Our Workflow

    Start

    Redoc - Overview of Redocly

    Start

    Redoc - Overview of Redocly and Project

    Start

    Redocly Demo - Redocly Dashboard

    Start

    Redocly Demo - Creating the Documentation

    Start

    Readme - Designing Your API Workflow

    Start

    Readme Demo - Overview of Project

    Start

    Readme - Overview of Readme Platform

    Start

    Readme Demo - Overview of Readme Dashboard

    Start

    Readme Demo - Importing API Definition

    Start

    Readme Demo - Adding Pages

    Start

    Readme Demo - Add External Links

    Start

    Readme Demo - Add Quick Demo

    Start

    Readme Demo - Publishing Your API Doc

    Start

    Gitbook - Designing Your Workflow

    Start

    Gitbook - Overview of Gitbook

    Start

    Gitbook Demo - Overview of Gitbook Platform and Project

    Start

    Gitbook Demo - Add Getting Started and Authentication Page

    Start

    Gitbook Demo - Create Our First Document Page

    Start

    Gitbook Demo - Create Landing Page

    Start

    Gitbook Demo - Update Content and Add New Endpoint

    Start

    Gitbook Demo - Adding Groups and External Links

    Start

    Gitbook Demo - Publishing Our Docs

    Start

    Activity 7

    Start

    Section 8: Building Developer Documentation
    Overview - What is DevPortal

    Start

    Overview - What Makes a Good DevPortal

    Start

    DevPortal Samples - Samples DevPortal

    Start

    DevPortal Samples - Sample 1 Deposits

    Start

    DevPortal Samples - Sample 2 Discord

    Start

    DevPortal Samples - Sample 3 Visa

    Start

    DevPortal Samples - Sample 4 Stripe

    Start

    DevPortal Samples - Sample 5 PlatformOS

    Start

    Docsify - Create DevPortal With Docsify

    Start

    Docsify - Docsify Overview

    Start

    Docsify - Why Company Should Use Docsify

    Start

    Docsify - Features of Docsify

    Start

    Docsify Demo - Create Theme - Installation

    Start

    Docsify Demo - Create Theme

    Start

    Docsify Demo - Writing Docs in Markdown

    Start

    Docsify Demo - Extend and Customize

    Start

    Docsify Demo - Deploy DevPortal

    Start

    Eleventy - Create DevPortal with Eleventy

    Start

    Eleventy - Eleventy Overview

    Start

    Eleventy - Features of Eleventy

    Start

    Eleventy - Why Companies Should Use Eleventy

    Start

    Eleventy Demo - Installation and Setup

    Start

    Eleventy Demo - Create a New Theme

    Start

    Eleventy Demo - Extending Theme

    Start

    Eleventy Demo - Deploying Eleventy

    Start

    VuePress - Create DevPortal with VuePress

    Start

    VuePress - VuePress Overview

    Start

    VuePress - Features of VuePress

    Start

    VuePress - Why Companies Should Use VuePress

    Start

    VuePress Demo - Setting Up VuePress

    Start

    VuePress Demo - Creating Theme - Homepage

    Start

    VuePress Demo - Creating Theme - Content

    Start

    VuePress Demo - Writing Docs in Markdown

    Start

    VuePress Demo - Extending VuePress

    Start

    VuePress Demo - Deploying VuePress

    Start

    MKDocs - Create DevPortal With MKDocs

    Start

    MKDocs - Features of MKDocs

    Start

    MKDocs - Why Companies Should Use MKDocs

    Start

    MKDocs Demo - Sample DevPortal

    Start

    MKDocs - MKDocs Overview

    Start

    MKDocs Demo - Setup and Installation

    Start

    MKDocs Demo - Creating New Theme

    Start

    MKDocs Demo - Extend and Customize

    Start

    MKDocs Demo - Deploying DevPortal

    Start

    Hugo - Create DevPortal With Hugo

    Start

    Hugo - Hugo Overview

    Start

    Hugo - Features of Hugo

    Start

    Hugo - Why Should Companies Use Hugo

    Start

    Hugo Demo - Creating Theme - Homepage

    Start

    Hugo Demo - Creating Theme - Content

    Start

    Hugo Demo - Write Docs in Markdown

    Start

    Building Developer Portal With Hugo : Deploying Hugo

    Start

    Activity 8

    Start

    Section 9: Building Developer-focused Help Centers
    Help Center - Overview of Help Centers

    Start

    Help Center - What is a Help Center?

    Start

    Help Center - Key Functions of Help Centers

    Start

    Help Center - Fetures of Help Centers

    Start

    Help Centers - Effective Help Center

    Start

    Help Center - Samples of Help Centers

    Start

    Vuepress - Overview Building With VuePress

    Start

    Vuepress - Sample VuePress Help Center

    Start

    Vuepress - VuePress Installation

    Start

    Vuepress - Default Theme

    Start

    Vuepress - Creating VuePress Theme 1

    Start

    Vuepress - Creating VuePress Theme 2

    Start

    Vuepress - Creating VuePress Theme 3

    Start

    Vuepress - Creating Theme - Customize and Extend

    Start

    Vuepress - Create Theme - Deploying

    Start

    Eleventy - Setting Up Eleventy

    Start

    Eleventy - Creating Theme - Homepage

    Start

    Eleventy - Creating Theme - Content

    Start

    Eleventy - Writing Docs in Markdown

    Start

    Eleventy - Extending Eleventy

    Start

    Eleventy - Deploying Eleventy

    Start

    Activity 9

    Start

    Section 10: Building Company Wiki
    What is Company Wiki?

    Start

    Company Wiki Sample

    Start

    Confluence - Overview of Confluence

    Start

    Confluence - Creating Your First Company Wiki

    Start

    Notion - Overview of Notion

    Start

    Notion - Creating Your First Company Wiki With Notion

    Start

    Activity 10

    Start

    Section 11: Building Company Knowledge Base
    Overview of Knowledge Base

    Start

    How to Create a Knowledge Base

    Start

    Create Knowledge Base With Confluence

    Start

    Notion Knowledge Base Sample

    Start

    Create Knowledge Base in Notion

    Start

    Activity 11

    Start

    Section 12: Landing Documentation Engineering Job
    How to Write a Resume

    Start

    Working as a Freelancer

    Start

    How to Create a Portfolio

    Start

    Where to Find Work

    Start

    Quiz - Landing Engineering Documentation Jobs

    Start

    Section 13: Introducing ChatGPT
    Introduction to ChatGPT and How it Works

    Start

    AI Limitations

    Start

    AI Terminology

    Start

    AI Tools

    Start

    Prompts Creation

    Start

    Creating a Mega Prompt

    Start

    AI Prompt for Content Outlining

    Start

    Create Information Architecture

    Start

    Editing With ChatGPT

    Start

    Capstone and Activities
    Congratulations!

    Start

    Capstone Project

    Start

    You should NOT take this course if:

    • You aren’t willing to engage in practical activities

    You SHOULD take this course if you are a software engineer who wants to:

    • Expand into a new area closely related to engineering
    • Be competitive in the market
    • Employ advanced documentation techniques
    • Be able to work with diverse technologies
    • Diversify your software engineering skills 

    Documentation Engineering for Developers

    Get reimbursed for Documentation Engineering for Developers
    Single - Documentation Engineering for Developers
    Fast-track your career by becoming a Certified Documentation Engineer
    $299
    1 Certificate Program
    GET ACCESS
    • 1 Certificate Program
    • Exclusive content
    • Community & (live) events
    • 30-day money-back guarantee
    Best Investment
    SALE
    Full Access
    Become a continuous learner and stay up-to-date with in-demand tech writing skills
    $2149
    $599
    9 Certificate Programs
    GET FULL ACCESS
    • 9 Certificate Programs
    • Exclusive content
    • Community & (live) events
    • 30-day money-back guarantee
    • Personal coaching
    • Competency assessments

    Testimonials

    teena merlin
    Teena Merlan
    Technical Writer
    “I wanted to let you know I signed an offer for my first official technical writing job yesterday!Thanks for your wonderful class and great resources. ”
    Hired at:
    Notarize
    Mak Keller
    Mak Keller
    Process Engineer
    I started the Technical Writer HQ course in early July with the goal of becoming an engineering technical writer or an engineering manager. The lectures and assignments gave me a lot of skills that I can take with me regardless of where my career path leads!
    Emily Martolini
    Emily Martolini
    UX Writer
    "The videos are informative and the homework makes sure you put the theory into practice. The most valuable part in my opinion is the capstone project. The detailed feedback was invaluable."
    Henry F
    Henry Fuse
    Engineer
    "​I took Josh's course, did the capstone project, and became certified in August. I've recently been offered a job as a Technical Writer for Amazon at $150k per year! I used my capstone project when they asked me for writing samples."​

    Our Alumni Work at These Companies

    illumina
    talkdesk-logo-2021-purple-rgb
    2560px-Amazon_logo.svg

    Frequently Asked Questions

    + - What is the duration of the Documentation Engineering for Developers certificate program?

    This self-paced course allows you to fit it into your personal and professional schedule. We suggest allocating at least 5 hours per week to complete it in approximately 12 weeks. However, the duration may vary due to the comprehensive nature of the course, which includes over 200 video lessons, practical activities, and a capstone project.

    + - Why should I enroll in this course?

    You should enroll in the course to expand your skills and become a more competitive engineer. By becoming a Certified Documentation Engineer, you’ll be well-equipped to lead documentation projects and significantly contribute to your organization’s success. This certification will not only bolster your skill set but also expand your career opportunities in technical communication.

    + - Are there any prerequisites for this course?

    No prerequisites are required to enroll in the Documentation Engineering for Developers course. However, because the course covers topics such as enterprise APIs and comprehensive developer documentation, we recommend that students have a background in engineering or technical writing.

    + - What is Technical Writer HQ?

    Technical Writer HQ is a leading community for technical writers across various domains, including XML writing, proposal writing, and grant writing. We offer training courses to professionals aiming to hone their technical writing skills. It’s a knowledge hub for writers eager to enhance their expertise continuously. The Technical Writer HQ’s leadership has been featured in top publications such as Forbes and Reuters.

    + - How long do I have access to the course?

    You will enjoy lifetime access to the Documentation Engineering for Developers course. Our commitment to your professional development is ongoing, which means we continuously update the course with new lessons, practical exercises, and bonus material. Once enrolled, you can access the course content anytime, on any device, ensuring you always have the latest information at your fingertips.

    + - What if I am not satisfied with the course?

    We are dedicated to providing a high-quality learning experience. If, for any reason, you are not satisfied with the course, please reach out to us within the first 30 days of enrollment for a full refund. Your feedback is invaluable as it helps us improve our offerings and better meet the needs of our learners.

    + - How and where can I display my certification upon completing the course?

    After successfully completing the course, you’ll receive a digital certification. You can showcase your certificate virtually or print it. We encourage you to display it on your LinkedIn profile, other social media platforms, and personal or professional website to highlight your newly acquired expertise to potential employers and peers.

    SHOW LESS SHOW MORE

    Related Certifications

    20 hours
    track

    UX Writing Certification Course

    Learn key fundamentals of writing microcopy, content design, conversation messaging, and how to stand out as a candidate to land the job.
    Explore
    Play
    20 hours
    track

    Grant Writing Certification Course

    Ready to become a certified grant writer? The Grant Writer Certification course focuses on the fundamentals of the Grant Writer role, along with an emphasis on the Grant Writer job description and winning grants.
    Explore
    Play
    20 hours
    track

    AI Technical Writing Certification

    Ready to become a certified AI technical writer? The AI Technical Writer Certification course focuses on using AI to streamline your documentation brainstorming, editing, and publishing process.
    Explore
    Play
    20 hours
    track

    Proposal Writing Certification Course

    Learn key fundamentals of being a proposal writer, how to write winning proposals, and how to stand out as a proposal writing candidate to land the job.
    Explore
    Play
    20 hours
    track

    Knowledge Management Certification

    Learn the key components of knowledge management, such as creating, capturing, organizing, sharing, and applying knowledge to enhance organizational performance and drive innovation.
    Explore
    Play
    20 hours
    track

    Technical Writing Certification

    Ready to become a certified technical writer? Learn key fundamentals of being a top technical writer, the skills for creating high-quality documentation, and how to stand out as a candidate to land the job.
    Explore
    Play