Learning path
Technical Writing learning path: everything to study, topic by topic
Comprehensive technical writing assessment covering writing fundamentals, documentation types, tools and workflows, API and developer documentation, content strategy, and documentation leadership.
Short answer
To learn Technical Writing, work through 6 modules and 22 topics in the order they build on each other. It starts with Writing Fundamentals, then moves on to Documentation Types and Tools & Workflows. Use the map as a checklist, or measure your level and study only what is missing.
What you will study
Topics are grouped by module. Open one to see its objectives and key concepts.
1 · Writing Fundamentals4 topics
Clarity & Conciseness
Eliminating ambiguity, reducing wordiness, active voice, plain language principles, sentence length guidelines, and readability scoring
Objectives
- Write clear and unambiguous technical content
- Apply plain language principles to simplify complex topics
Key concepts
- active voice
- plain language
- sentence length
- readability scores
- eliminating jargon
- concrete language
Audience Analysis
Identifying reader personas, skill level assessment, task-oriented writing, adapting tone and depth, user journey mapping for documentation
Objectives
- Identify and define target audiences for documentation
- Adapt writing style and depth to match reader needs
Key concepts
- reader personas
- skill level assessment
- task-oriented writing
- tone adaptation
- prerequisite knowledge
- user journey mapping
Structure & Organization
Document outlines, heading hierarchies, logical flow, chunking information, progressive disclosure, table of contents design, and cross-referencing
Objectives
- Create well-organized document structures with clear hierarchy
- Apply progressive disclosure to guide readers through complex content
Key concepts
- heading hierarchy
- logical flow
- information chunking
- progressive disclosure
- table of contents
- cross-referencing
- scannable layouts
Grammar & Style Guides
Technical style guides (Google, Microsoft, Apple), consistent terminology, punctuation conventions, capitalization rules, and word lists
Objectives
- Follow established style guides for technical documentation
- Maintain consistent terminology across documents
Key concepts
- style guide adherence
- terminology consistency
- capitalization rules
- punctuation conventions
- word lists
- voice and tone guidelines
2 · Documentation Types4 topics
Tutorials
Step-by-step learning guides, scaffolded exercises, prerequisite identification, learning outcomes, progressive complexity, and hands-on examples
Objectives
- Design tutorials that guide beginners through a complete workflow
- Structure learning content with clear milestones and outcomes
Key concepts
- step-by-step structure
- learning outcomes
- scaffolding
- progressive complexity
- hands-on exercises
- checkpoint validation
How-To Guides
Task-oriented procedures, numbered steps, prerequisites and warnings, troubleshooting sections, expected outcomes, and conditional branching
Objectives
- Write clear procedural documentation for specific tasks
- Include appropriate context and troubleshooting guidance
Key concepts
- task orientation
- numbered procedures
- prerequisites and warnings
- troubleshooting tips
- expected outcomes
- conditional steps
Reference Documentation
Parameter tables, return values, error codes, configuration options, data type specifications, completeness requirements, and search optimization
Objectives
- Create complete and accurate reference documentation
- Organize reference content for quick lookup and discoverability
Key concepts
- parameter tables
- return value documentation
- error code catalogs
- configuration references
- data type specifications
- completeness audits
Conceptual Documentation
Architecture overviews, concept explanations, mental models, diagrams and visuals, analogies, and background context for decision-making
Objectives
- Explain complex technical concepts using clear mental models
- Create effective visual aids to supplement written explanations
Key concepts
- architecture overviews
- mental models
- diagrams and visuals
- analogies for complex concepts
- decision context
- background explanations
3 · Tools & Workflows4 topics
Markup Languages
Markdown, reStructuredText, AsciiDoc, DITA XML, semantic markup, content modeling, and format conversion
Objectives
- Choose appropriate markup languages for different documentation needs
- Write well-structured content in multiple markup formats
Key concepts
- Markdown syntax
- reStructuredText
- AsciiDoc
- DITA XML
- semantic markup
- format conversion tools
Docs-as-Code
Version control for docs, static site generators (MkDocs, Docusaurus, Hugo), CI/CD pipelines for publishing, pull request workflows, and automated testing
Objectives
- Implement docs-as-code workflows using version control and CI/CD
- Configure static site generators for documentation publishing
Key concepts
- version control for docs
- static site generators
- CI/CD publishing pipelines
- pull request workflows
- automated link checking
- build and deploy automation
Review Processes
Technical review cycles, SME collaboration, editorial reviews, feedback incorporation, sign-off workflows, and review checklists
Objectives
- Manage effective documentation review processes with stakeholders
- Incorporate technical and editorial feedback systematically
Key concepts
- technical review cycles
- SME collaboration
- editorial review
- feedback loops
- sign-off workflows
- review checklists
Content Reuse & Single-Sourcing
Content reuse strategies, single-sourcing, conditional text, variables and snippets, topic-based authoring, and component content management
Objectives
- Design content architectures that maximize reuse across deliverables
- Implement single-sourcing strategies to reduce maintenance overhead
Key concepts
- single-sourcing
- conditional text
- variables and snippets
- topic-based authoring
- content components
- reuse patterns
4 · API & Developer Docs4 topics
API Reference Writing
OpenAPI/Swagger documentation, endpoint descriptions, request/response schemas, authentication flows, rate limiting docs, and versioning communication
Objectives
- Write comprehensive API reference documentation from specifications
- Document authentication flows and error handling for API consumers
Key concepts
- OpenAPI specifications
- endpoint descriptions
- request/response schemas
- authentication documentation
- rate limiting docs
- API versioning
Code Samples & Examples
Writing runnable code examples, multi-language samples, copy-paste readiness, error handling in examples, and testing code samples for accuracy
Objectives
- Create code samples that are accurate, runnable, and instructive
- Maintain code examples across multiple programming languages
Key concepts
- runnable examples
- multi-language samples
- copy-paste readiness
- error handling in examples
- sample testing
- progressive complexity in examples
SDK Documentation
SDK quickstart guides, installation instructions, client library documentation, migration guides, changelog management, and deprecation notices
Objectives
- Produce SDK documentation that accelerates developer onboarding
- Write migration guides that minimize developer friction during upgrades
Key concepts
- quickstart guides
- installation instructions
- client library docs
- migration guides
- changelog management
- deprecation notices
Developer Portals
Developer portal design, interactive API explorers, sandbox environments, onboarding flows, getting-started journeys, and developer experience optimization
Objectives
- Design developer portals that optimize for self-service onboarding
- Create cohesive documentation experiences across multiple API products
Key concepts
- portal information architecture
- interactive API explorers
- sandbox environments
- onboarding flows
- developer experience
- getting-started journeys
5 · Content Strategy3 topics
Information Architecture
Taxonomy design, navigation patterns, search optimization, content mapping, user flow modeling, card sorting, and tree testing
Objectives
- Design information architectures that scale with growing content libraries
- Conduct user research to validate navigation and taxonomy decisions
Key concepts
- taxonomy design
- navigation patterns
- search optimization
- content mapping
- card sorting
- tree testing
- user flow modeling
Content Governance
Content audits, freshness policies, ownership models, deprecation workflows, quality standards, and content lifecycle management
Objectives
- Establish governance processes that maintain documentation quality at scale
- Design content lifecycle policies that prevent documentation rot
Key concepts
- content audits
- freshness policies
- ownership models
- deprecation workflows
- quality standards
- content lifecycle management
Localization & Internationalization
Translation workflows, internationalization best practices, locale-aware content, translation management systems, cultural adaptation, and multilingual style guides
Objectives
- Design documentation pipelines that support efficient localization
- Apply internationalization best practices to source content
Key concepts
- translation workflows
- internationalization (i18n)
- locale-aware content
- translation management systems
- cultural adaptation
- multilingual style guides
6 · Documentation Leadership3 topics
Documentation Program Management
Documentation roadmaps, resource planning, cross-functional alignment, stakeholder management, prioritization frameworks, and capacity planning
Objectives
- Build and execute documentation roadmaps aligned with product releases
- Manage documentation priorities across competing stakeholder demands
Key concepts
- documentation roadmaps
- resource planning
- cross-functional alignment
- stakeholder management
- prioritization frameworks
- capacity planning
Metrics & Analytics
Documentation analytics, page views and engagement metrics, search analytics, feedback collection, support ticket deflection, and ROI measurement
Objectives
- Define and track metrics that demonstrate documentation impact
- Use analytics to prioritize content improvements and investments
Key concepts
- documentation analytics
- engagement metrics
- search analytics
- feedback collection
- support ticket deflection
- ROI measurement
Team Standards & Mentorship
Style guide creation, writing templates, onboarding new writers, quality bar definition, peer review culture, and continuous improvement programs
Objectives
- Create and maintain style guides and templates that scale writing quality
- Build mentorship programs that develop junior writers into senior contributors
Key concepts
- style guide creation
- writing templates
- writer onboarding
- quality bar definition
- peer review culture
- continuous improvement
Levels: Junior, Mid, Senior, and Expert
Explain it in your own words
Graded by AI · no account · 1 questionNo options to guess from: you write, the AI grades against the topic's rubric and tells you what level your answer reads at.
Already studying Technical Writing?
The assessment measures topic by topic, and your plan skips what you already know.
Open to read. An account is only needed to be measured.
Frequently asked questions
Where should I start studying Technical Writing?
Start with Writing Fundamentals: Clarity & Conciseness, Audience Analysis, and Structure & Organization. The map orders topics by what they depend on, so each one prepares the next.
How long does a full Technical Writing assessment take?
A full assessment of this path takes about 45 minutes. Study time depends on where you start; a diagnostic shows which topics you can skip.
Do I need an account to use this page?
No. The map, objectives and key concepts are open. You only need an account to be measured, get your gap by topic and receive a plan.