Advanced Resources
On this page
- 1. Content strategy and governance
- 2. Measurement
- 3. Cross-functional influence
- 4. Information architecture at scale
- 5. Using AI in senior-level technical writing
- 6. Tooling and automation
- 7. Documentation specialisations
- 8. Video tutorials (WriteTech Hub)
- 9. Ownership and community contribution
- 10. Career paths and staying current
- Capstone deliverable: Docs Programme Pack
This level is for writers who are already producing good documentation and want to work at a programme level. The skills here are not about writing more document types or using more sophisticated tools. They are about operating at a different scope: owning documentation across an entire product or system, making strategic decisions about what gets documented and how, and building processes that let a documentation programme function without depending on any single person.
This means thinking about governance and standards, measuring whether your documentation is working, influencing the people and decisions that determine documentation quality upstream, and building tooling and automation that give you leverage.
1. Content strategy and governance
Most documentation problems are not writing problems. They are strategy problems because nobody defined what the documentation should cover, who is responsible for it, or what happens when it goes out of date. Content strategy is the work of answering those questions before they become problems.
At the advanced level, you should be able to define and document a strategy for a documentation programme, not just contribute to one.
Core areas to develop
Scope and vision. What does this documentation cover, for which readers, and what is explicitly out of scope? The out-of-scope question is as important as the in-scope one. Documentation that tries to cover everything covers nothing well.
Ownership. Who is responsible for which content? What happens when an owner leaves or a product changes? A documentation programme without a clear ownership model accumulates orphaned pages.
Content standards and templates. What does a good tutorial look like in this codebase? What fields does an API reference entry require? Templates reduce the decision load for contributors and make reviews faster.
Deprecation and versioning policy. Old documentation does not disappear on its own. Define how outdated content is identified, marked, and removed. Define how documentation maps to product versions and what happens at a major release.
Resources
- WriteTech Accelerator Programme is a project-based programme for writers ready to work on production-level documentation. Participants adopt docs-as-code workflows and build a portfolio of real documentation artefacts.
- Technical Content Marketing: A 7-Step Strategy explains how content strategy is applied in technical environments, including planning, structuring, and aligning documentation with user needs and product goals. It shows how strategy connects documentation to product communication at scale.
- Content Strategy: My simple (but complete) guide for 2026 provides a practical breakdown of content strategy for technical writers, including planning, structuring documentation systems, and maintaining consistency across documentation sets. It is written specifically for documentation practitioners.
- Stages of Building a Technical Documentation Content Strategy for Tech Firms explains how documentation teams evolve from ad-hoc writing to structured strategy, including planning stages, governance decisions, and scaling documentation systems.
- Content Strategy 101: Building a Foundation for Technical Documentation introduces the fundamentals of content strategy in technical documentation, focusing on structure, planning, and aligning documentation with user needs and business goals.
- Content Governance 101 explains the core principles of governance, including ownership, workflow definition, review cycles, and content accountability in documentation systems.
- What Is a Content Governance System? A Guide breaks down how governance systems work in practice, including roles, rules, workflows, and enforcement mechanisms that ensure documentation stays accurate over time.
- Content Governance Best Practices outlines practical approaches to managing content quality, including approval workflows, consistency enforcement, and long-term maintenance planning.
Practice
Write a 2-3 page content strategy document for a documentation project of your choice. This can be based on a fictional or real system such as:
- A task management app like Trello or Notion
- A note-taking app like Notion, Obsidian, or Evernote
- A cloud storage service like Google Drive or Dropbox
Choose something simple enough that you can clearly define its users and documentation needs.
Your content strategy document must include:
- Audience definition: who the documentation is for (e.g. developers, end users, beginners, internal teams) and what each group needs
- Scope definition: what the documentation will cover and what is explicitly out of scope
- Content ownership model: who is responsible for creating, maintaining, and updating each part of the documentation
- Review and update process: how content is reviewed, how often it is updated, and what triggers a review
- Deprecation policy: how outdated content is identified, marked, and removed or archived
Your document should feel like something a real documentation team could use to guide how they manage their content. It should clearly define decisions, responsibilities, and boundaries.
2. Measurement
Most documentation work is evaluated on the basis of volume, such as how many pages exist, how recently they were updated, and whether the backlog is shrinking. None of those things tells you whether the documentation is actually working. Building the habit of measuring documentation outcomes is one of the things that distinguishes a senior writer from a mid-level one.
The challenge is that documentation quality is hard to measure directly. You are usually measuring proxies, and it takes discipline to choose proxies that are meaningful rather than easy.
Metrics worth thinking about
- Task completion rates: Can readers do what they came to the documentation to do?
- Search success: What are people searching for and not finding? What searches return no results?
- Support ticket content: Are there recurring questions that documentation should already answer?
- Page engagement: Are readers reaching the end of long pages, or leaving partway through?
Tools you can use to measure these metrics
- Google Analytics is commonly used to track page views, user flow, bounce rates, and time on page. It helps you understand how users move through documentation.
- PostHog provides product analytics that can be used to track user journeys, events, and interactions inside documentation portals or developer tools.
- Hotjar allows you to see heatmaps and session recordings to understand where users scroll, click, or get stuck.
- GitBook Analytics (or similar documentation platforms like ReadMe or Docusaurus plugins) can show page-level engagement, popular pages, and navigation patterns.
- Zendesk or HelpScout can be used to analyze support tickets and identify recurring documentation-related questions.
- Sentry (or similar error tracking tools) can indirectly support documentation measurement by showing where users encounter integration or usage errors that documentation should help prevent.
Practice
Write a metrics plan for a documentation project. You may base your project on:
- A SaaS product (e.g. Notion-style task manager, expense tracker, learning platform)
- An API service (e.g. Stripe-like payments API or GitHub-style API)
- A developer tool (e.g. CLI tool or deployment system)
Your plan must include:
- 3-5 metrics you will track
- What each metric actually tells you about documentation quality
- What each metric does not tell you (important for avoiding false conclusions)
- How you would collect the data (which tools or systems you would use)
- What a “meaningful improvement” would look like for each metric
Resources
- 5 Metrics to Measure Documentation Quality explains practical ways to evaluate documentation using real-world signals such as readability, usability, content quality, navigation, and customer satisfaction. It breaks down each metric with examples of how teams apply them in practice to understand whether documentation is actually helping users.
- Documentation Metrics: How to Measure Documentation Quality explores how technical writers define meaningful documentation goals and choose metrics that actually reflect user success. It also highlights an important limitation of metrics: they show what happened, but not why it happened, which is why measurement must always be paired with user context and qualitative research.
3. Cross-functional influence
At the advanced level, the limiting factor for documentation quality is rarely the writing. It is the decisions made upstream, including unclear product requirements, engineering work that ships without a docs review, and feature changes that nobody told the documentation team about. The only way to address those problems is to be in the room where the decisions are made, or to have relationships with the people who are.
Things to work on
Get upstream. Attend product planning and sprint review meetings. The main cost is time, but the benefit is significant. You catch documentation issues early, while they are still easy to fix, instead of discovering them after a feature has already shipped.
It also gives you a voice in shaping the product itself. Instead of waiting for features to be handed over, you can flag potential user experience or clarity issues early and help resolve them before they are baked into the product.
This shifts documentation work from being reactive to proactive, as you influence how the product and its communication are built from the start.
Agree on a definition of done. Work with engineering to establish that documentation is part of the definition of done for a feature, not something that happens after.
Design reviews that get responses. The reason most documentation reviews are slow is that reviewers do not know what they are being asked to do. A review request with a specific question (“Does this accurately describe the authentication flow?”) gets a faster and more useful response than one that asks for general feedback.
Build relationships with support. Support teams see documentation failures before anyone else does. A regular conversation with support about recurring questions is one of the most efficient ways to identify documentation gaps.
Resources
- Why Tech Writers Belong in Initial Product Dev Meetings explains how early involvement reduces costs, increases efficiency, and enhances UX by aligning terminology and catching usability issues before they are baked into the product. It breaks down practical steps like inviting writers to kickoffs, sharing prototypes early, and positioning the writer as a user advocate who asks clarifying questions about navigation and transitions.
- Technical Writing in a Multi-Team Agile Environment provides practical guidance on which Agile meetings writers should attend, including sprint planning as essential, daily scrums two to three times per week, and retrospectives for senior writers. It includes a checklist of what to accomplish in scrums to make attendance productive rather than passive.
- What is the Definition of Done (DoD) in Agile? explains how the DoD is a shared checklist for when work is truly complete, created collaboratively by the whole team and reviewed quarterly. It shows why documentation updates should be a non-negotiable criterion and how framing it as a shared quality standard makes it more likely to be followed consistently.
- Definition of done (DoD): Checklist examples for Agile teams shows how documentation updates fit into story-level, sprint-level, and release-level definitions of done. It emphasizes that unfinished docs create support tickets, delay releases, and force rework, making the case for including documentation as a core completion criterion.
- How to manage cross-functional teams effectively provides a practical system for managing cross-functional collaboration, including aligning on a single shared outcome, defining roles and decision rights, establishing clear communication norms, and running lightweight execution cadences. It emphasizes planning with dependencies and capacity in mind, and managing blockers as first-class work items rather than side conversations. For documentation leaders, this translates to treating content alignment across teams as a project with its own goals, owners, and metrics.
4. Information architecture at scale
Information architecture at the intermediate level is about structuring a single documentation site well. At the advanced level, it is about structuring documentation systems: multiple products, multiple audiences, multiple versions, potentially multiple languages, all of which need to feel coherent to a reader who may only ever see one corner of the whole system.
Core concepts to develop
Multi-product ecosystems. How do shared concepts, shared navigation, and shared terminology work across a family of products? What is centralised and what lives with the individual product?
Taxonomies and metadata. Tagging content consistently makes it possible to surface the right documentation in search, filter by audience or product version, and reuse content across contexts. This requires defining the taxonomy before you start tagging, not after.
Content modelling. Before writing, define what content types exist and what fields each type requires. A content model for an API reference entry might require: endpoint, method, description, parameters, authentication, example request, example response, and error codes. Defining this upfront makes both writing and review faster.
Localisation readiness. If there is any chance your documentation will be translated, the time to structure it for translation is before you write it, not after. Avoid embedded text in images, cultural references that do not translate, and sentence structures that break under translation.
Practice
Choose an existing documentation site that has grown over time and now feels inconsistent, duplicated, or difficult to navigate. This could be a small open-source project or a well-known product with public documentation.
Good starting examples include:
- Mautic documentation
- Wagtail CMS documentation
- CHAOSS documentation
- Flask documentation
- GitHub Docs (only focus on one section, not the entire site)
Your task is to redesign its information architecture, as if you were joining the documentation team and improving the structure for scale.
You should produce:
- A before-and-after sitemap: Show how the documentation is currently structured, then how you would restructure it. This should make it clear what you moved, merged, split, or removed.
- Defined content types: Identify the types of documentation you would enforce in the structure (for example: tutorials, how-to guides, reference, explanations). Explain where each type belongs and why.
- Rationale for your decisions: Explain the reasoning behind your restructuring. Focus on user needs, navigation clarity, duplication issues, and content clarity rather than aesthetics.
- Localisation considerations: Identify at least three issues in the existing documentation that would make translation or localisation difficult. These could include:
- Unclear or inconsistent terminology across pages
- Mixed content types within a single page (e.g., tutorial + reference together)
- Culturally specific examples that do not translate well
- Inconsistent UI labels or product terms
- Duplicated content that would increase translation cost and inconsistency
Then briefly explain how your redesign would reduce or solve these issues.
Resources
- How to structure your documentation’s information architecture (IA) provides a practical framework for mapping product portfolios, brands, product areas, and endpoints to create a coherent IA. It breaks down the process into exercises that help teams identify friction points, mock up structures, and iterate based on usability testing, making it especially useful for teams managing multiple products or platforms.
- Best Practices for Metadata Tagging outlines how to establish a clear metadata strategy, create controlled vocabularies, and implement taxonomies or ontologies that organize terms into structured hierarchies. It emphasizes that metadata should be treated as a strategic initiative rather than an afterthought, with human-supervised automation and regular audits to maintain quality over time.
- Scalable Content Taxonomy for Technical Documentation focuses specifically on documentation taxonomies, explaining how to audit existing content for redundant categories, define essential categories based on user needs rather than org charts, and enforce taxonomy compliance at scale using automated scanning and scoring against defined standards.
- Content Modeling for Technical Writing: Definition, Importance, Creating applies content modeling specifically to technical writing, showing how to create taxonomies of content types and establish relationships between them. It demonstrates how a single content model can be reused across different products or contexts, saving time and ensuring consistency.
- Best Practices for Writing Content for Localization covers how to provide context to translators through code comments, glossaries, and style guides, and why giving translators access to the software or reference material like wireframes and mockups improves translation quality. It emphasizes proofreading source content before translation, since errors in the source propagate across all language versions.
- Best practices in software localization: A practical guide for 2026 explains the foundational technical practice of separating application logic from language content using translation keys, designing key architecture deliberately with meaningful hierarchies, and building RTL support from the beginning using CSS logical properties. It also covers why context quality is directly tied to translation quality and how providing screenshots, character limits, and descriptions reduces rework.
5. Using AI in senior-level technical writing
At the advanced level, AI is not a writing assistant. It is a strategic capability that requires governance, infrastructure, and risk management. You design the systems that make AI scalable and safe across teams, not just use AI tools for your own drafts.
What you should own at this level
1. Agentic AI and multi-step workflows
Design AI systems that can complete complex documentation tasks through reasoning and action loops. This includes ReAct (Reason + Act) patterns, where AI systems iterate through thought → action → observation to complete tasks grounded in real systems.
For example, design an agent that:
- Reads a code repository and identifies changed endpoints
- Updates API documentation based on those changes
- Opens a pull request for human review
- Flags any changes that need SME verification
The agent does not replace the writer. It automates the routine parts of the workflow so writers can focus on judgment and quality.
2. Prompt systems and governance
Build enterprise prompt frameworks that teams can rely on. This includes:
- Reusable prompt libraries: versioned, tested prompts for common documentation tasks (release notes, API reference entries, troubleshooting guides, onboarding content)
- Prompt evaluation datasets: collections of test inputs and expected outputs that let you measure whether a prompt change improves or degrades results
- A/B testing for prompts: running variants against each other to find which produces more accurate, consistent output
- Prompt review workflows: treating prompt changes like code changes, with pull requests, review, and rollback capability
A prompt library at this level is a team asset with documentation, ownership, and maintenance processes.
3. Retrieval-Augmented Generation (RAG) for documentation
Design systems where AI retrieves information from your documentation corpus before generating responses. This ensures AI-generated answers are grounded in your actual content, not generic training data.
Key design decisions you will own:
- Chunking strategy: how to break documentation into retrievable units. Each chunk should be self-contained and answer a specific question. Too large and retrieval misses detail; too small and context is lost.
- Embedding models: selecting models that understand technical vocabulary and code. Standard models may miss API-specific terminology or confuse similar-sounding endpoints.
- Vector database and indexing: how content is stored, updated, and queried. When documentation changes, the index must update without breaking existing queries.
- Source attribution: ensuring AI responses can point back to specific documentation pages, not just general knowledge. Users must be able to verify what the AI told them.
- Hybrid search: combining semantic search (what the user meant) with keyword search (exact terms like API endpoint names) for better retrieval accuracy.
4. Quality and risk management for AI-assisted docs
Establish the systems that catch AI failures before they reach readers. This includes:
- Regression tests for AI output: automated tests that run AI-generated content through the same checks as human-written content (Vale linting, link validation, code sample testing)
- Evaluation datasets: curated sets of questions and expected answers that you run against your AI system regularly to detect drift or degradation
- Release gates: defining what must pass before AI-assisted documentation can be published. This might include human review for certain content types, automated checks for others, and SME sign-off for API reference changes.
- Escalation paths: when AI produces incorrect or harmful content, who is notified, how is it corrected, and how is the system improved to prevent recurrence
- Responsible AI guidelines: team-level policies on what AI can be used for, what data can be fed into AI tools, and what review is required for different risk levels
What you can use AI for at this level
- Automate documentation updates from code changes: design pipelines that detect API changes, generate updated reference docs, and flag human reviewers for verification
- Build intelligent search and chat systems: create RAG-based systems that answer user questions using your documentation corpus, with source attribution and confidence scoring
- Generate and maintain documentation at scale: design systems that produce first drafts for large product surfaces, with human review gates for accuracy and tone
- Analyse documentation effectiveness: use AI to process support tickets, identify documentation gaps, and prioritise content investments based on actual user pain points
- Dynamic content personalisation: implement systems that adjust tone, depth, and examples based on the reader’s role without maintaining separate document versions
- Content migration and restructuring: use AI to assist with large-scale documentation migrations, identifying content relationships, suggesting new structures, and flagging content that needs human review
What you should not rely on AI for at this level
- Final accountability for accuracy: AI systems fail. You own the escalation path, the remediation, and the communication when they do.
- Strategic decisions about what to document: AI can suggest, but only humans can prioritise based on business context, user needs, and product direction.
- Ethical and compliance judgments: AI does not understand regulatory requirements, cultural sensitivity, or organisational risk appetite. You do.
- Governance and policy decisions: who can use AI, for what purposes, with what review, these are human decisions that require understanding of organisational context, legal constraints, and team capacity.
Practice
Design an AI-assisted documentation system for a hypothetical product. Your deliverable should include:
- A system architecture diagram showing how AI fits into the documentation workflow, from content creation to publication to reader-facing search/chat
- A prompt library with 5 reusable prompts for common documentation tasks, versioned and tested, with evaluation notes for each
- A RAG configuration showing how documentation content is chunked, embedded, and retrieved, with specific decisions on chunk size, embedding model, and update frequency
- A quality assurance plan with evaluation criteria, test cases, and escalation procedures for when AI output fails
- A governance document defining who can use AI, for what purposes, with what review requirements, and what data must never be fed into AI tools
Resources
- Prompt Engineering Guide: Advanced techniques for designing, testing, and deploying prompt systems at scale. Covers chain-of-thought, ReAct, self-consistency, and prompt versioning. Essential for building enterprise prompt libraries.
- Building RAG Applications with LangChain: A practical course on building retrieval-augmented generation systems for documentation and knowledge bases. Covers chunking, embeddings, vector stores, and evaluation.
- AI Risk Management Framework: The US National Institute of Standards and Technology framework for managing AI risks, including governance, measurement, and mitigation. Essential for designing responsible AI systems in documentation.
- Responsible AI Practices: Google’s operational guidance on building AI systems responsibly, including fairness, transparency, accountability, and privacy. Useful for establishing team-level AI ethics standards.
6. Tooling and automation
At the advanced level, tooling is not about knowing which tools exist. It is about building systems that maintain documentation quality at scale without requiring constant manual oversight. The goal is leverage, meaning the ability to maintain a high-quality documentation programme without headcount growing in proportion to content volume.
1. Continuous Integration pipelines for documentation
A documentation continuous integration (CI) pipeline should run on every pull request and include at minimum:
- Documentation build checks (to ensure the site compiles successfully)
- Broken link checks (to prevent navigation failures)
- Prose linting using Vale (style, tone, and consistency rules)
- Spell checking
Optionally, you can add:
- Terminology enforcement for product-specific language
- Link validation across versioned docs
- Markdown or structure validation rules
All CI rules and checks should be documented in CONTRIBUTING.md so contributors understand what is being enforced and why.
2. Platform and documentation lifecycle management
Beyond individual pull requests, documentation systems often break at the platform level, especially during migrations or upgrades.
Common migrations include moving between tools like Hugo, MkDocs, Docusaurus, or GitBook.
Before starting a migration, you should clearly define:
- What problems exist in the current system (scalability, usability, maintenance, etc.)
- What the new platform improves
- How content will be migrated and validated
- How long the transition period will last
- Who owns content cleanup during and after migration
3. API documentation automation
Some documentation can be generated automatically, especially API reference material.
Tools like OpenAPI and Swagger allow documentation to be generated directly from API specifications, keeping reference material aligned with code automatically.
However, automation has clear limits:
- It can generate accurate reference content
- It cannot replace guides, tutorials, explanations, or examples
- It does not understand user intent or learning flow
At this level, your job is to decide what should be automated and what must remain human-written, and to design a workflow where both coexist.
Resources
- Prose Linting with Vale (Meilisearch) is a practical walkthrough for setting Vale up in a CI pipeline.
- Elastic Vale Rules on GitHub is an open-sourced example of a large organisation’s full Vale configuration, useful as a reference when building your own.
- Documenting APIs: A Guide for Technical Writers covers OpenAPI and Swagger in the context of a broader API documentation workflow.
- Docs Linting Guide explains how documentation linting applies the same engineering rigor to prose that code linters apply to software, catching broken links, style violations, and terminology issues before deployment. It breaks down how Vale scans prose for voice, wording, and structure, and how integrating these checks into CI/CD pipelines prevents documentation errors from reaching production.
- 4 Steps for a Successful Content Migration Project breaks down the post-migration review process into peer review, AI-powered proofreading, and final output checks. It explains how to verify that migrated content adheres to requirements, that table of contents layouts and pagination function correctly, and that build logs show no warnings or errors that need attention.
- Run code migrations (OpenAI Codex) offers an advanced framework for controlled migrations, applicable to documentation platform transitions. It recommends inventorying legacy assumptions, mapping old systems to new ones, proposing incremental migration plans with compatibility layers, and running validation after each milestone rather than waiting for a full cutover. This approach of working in checkpoints with explicit parity tests applies directly to documentation tooling migrations.
- OpenAPI Specification Guide: Structure Implementation & Best Practices explains the benefits of OpenAPI for automated documentation and code generation, including standardized machine-readable formats, automatic generation of client SDKs and server stubs, and simplified testing through mock servers. It emphasizes maintaining a single source of truth and using continuous integration to validate specs against actual API behaviour.
- Best Practices - OpenAPI Documentation from the OpenAPI Initiative provides authoritative guidance on keeping OpenAPI descriptions as first-class source files, making them available to users for client generation, and using design-first approaches to prevent issues before development begins. It notes that there is seldom need to write OpenAPI descriptions by hand, since editors, domain-specific languages, and code annotations can generate them automatically.
7. Documentation specialisations
Advanced writers often develop depth in one or two areas while maintaining broad enough coverage to contribute across a documentation programme. The areas below are the most common specialisations for senior writers.
API documentation involves writing complete API references with endpoint descriptions, parameter tables, authentication flows, and tested code examples. It requires close collaboration with engineers to keep documentation accurate as the API evolves, and familiarity with OpenAPI/Swagger tooling.
User documentation focuses on guides, FAQs, onboarding materials, and help centre content for non-technical or mixed audiences. The emphasis is task-based writing: give readers the shortest path to completing what they came to do.
Product documentation covers feature descriptions, changelogs, and release notes. It requires staying in sync with product releases and maintaining close relationships with product managers to capture decisions and intent accurately.
Developer documentation includes SDK guides, architecture overviews, setup instructions, and tutorials for developers onboarding to a platform. It requires enough technical depth to explain system behaviour accurately, and enough clarity to serve developers who are new to the platform.
Long-form and whitepaper content covers in-depth technical explanations, research summaries, and strategic documents. The skills here overlap with technical writing but extend into document architecture, argument structure, and editorial judgement for long-form work.
8. Video tutorials (WriteTech Hub)
The sessions below are from the WriteTech Accelerator Program. They cover CI/CD, automated linting, AI and ML documentation, infrastructure documentation, DevOps, and Web3. The “relates to” column points to the section above that each video supports.
| Relates to | # | Video | Duration |
|---|---|---|---|
| General review | 1 | WriteTech Accelerator Program Onboarding | 47:02 |
| Section 1: Content strategy | 2 | Week 3, Session 1: Introduction to CI/CD for Technical Writers | 1:40:53 |
| Section 5: Tooling | 3 | Week 3, Session 2: Introduction to Automated Linters | 1:56:07 |
| Section 5: Tooling | 4 | Week 3, Session 3: Automated Linters for API Documentation | 1:49:20 |
| Section 5: Tooling | 5 | Week 3, Session 4: Documentation Workflows and AI Integration | 1:13:29 |
| Section 6: Specialisations | 6 | Week 4, Session 1: Documenting AI/ML Systems | 1:07:52 |
| Section 5: Tooling | 7 | Week 4, Session 2: Using AI Tools in Your Documentation Workflow | 1:04:55 |
| General review | 8 | Week 5: Ask Me Anything and Feedback, Weeks 1 to 4 | 2:01:37 |
| Section 5: Tooling | 9 | Week 5, Session 1: Docs in the DevOps Ecosystem | 1:46:50 |
| Section 6: Developer docs | 10 | Week 5, Session 2: Infrastructure Docs and YAML/Terraform Annotations | 2:01:50 |
| Section 6: Developer docs | 11 | Week 5, Session 3: Getting Started with Terraform for Technical Writers | 1:38:23 |
| Section 7: Real-world ownership | 12 | Week 6, Session 1: Open Source DevOps Docs Audit | 1:25:34 |
| Section 6: Specialisations | 13 | Week 7, Session 2: Web3 Docs in Practice | 1:17:40 |
| Section 3: Cross-functional influence | 14 | DevOps and Technical Writing | 1:11:39 |
Watch the onboarding session first, then follow the CI/CD and linting cluster (sessions 2 to 5) alongside section 5. The DevOps and infrastructure sessions (9 to 12) work best once you are comfortable with tooling. The AI/ML and Web3 sessions (6 to 7, 13) are domain-specific deep dives for when you are exploring a particular specialisation.
9. Ownership and community contribution
At the advanced level, you are no longer only contributing documentation inside a system. You are responsible for how documentation systems behave over time, how they scale across teams, and how they stay aligned with the product and the wider organisation.
This includes technical writing work, but also system design, coordination, and long-term maintenance across people, processes, and content types.
The focus moves from “writing documentation” to owning documentation as an evolving product.
Things worth aiming for
1. Lead documentation end-to-end
Take ownership of documentation from early planning through to publication and iteration. This includes structuring content, aligning with engineering and product teams, and ensuring documentation stays current after release.
2. Redesign documentation systems
Work on documentation that has outgrown its original structure and redesign its information architecture, workflows, and content types so it scales better for users, contributors, and translators.
3. Define and maintain documentation standards
Create and maintain documentation guidelines, templates, and review workflows for a team or organisation. This includes aligning documentation with:
- Product and engineering workflows
- Support and customer success needs
- Marketing or external communication content
- Internal training and onboarding materials
4. Define documentation standards, templates, and review workflows for a team, and maintain them over time
At the senior and staff levels, documentation work shifts from individual contribution to system design. You are no longer only writing documentation; you are building the infrastructure that allows a team, or multiple teams, to produce consistent, high-quality documentation at scale. This includes creating standards that align with product and engineering workflows, designing templates that reduce cognitive load for contributors, establishing review workflows that catch issues without creating bottlenecks, and ensuring that marketing content, support materials, internal training, and external documentation all speak with the same voice. The goal is not control for its own sake, but clarity: when everyone understands how documentation is structured, reviewed, and maintained, the quality of the entire ecosystem improves without requiring constant intervention.
Things to work on
Build a documentation governance framework. A governance framework is not a style guide alone. It is the set of policies, roles, and processes that determine how documentation is created, reviewed, published, and retired across the organization. This includes defining who owns which docs, how content is classified and tagged, what the review cadence looks like, and how standards are enforced. At the enterprise level, governance models typically fall into three categories: centralized (a single team sets all policies), federated (domain teams manage their own docs within enterprise-wide standards), or hybrid (centralized policy-setting with federated execution). The right model depends on your organization’s size, regulatory environment, and need for agility. What matters most is that the framework is documented, communicated, and regularly reviewed, rather than existing as an unwritten assumption.
Design templates that encode standards. A good template does more than provide a heading structure. It encodes the content model for a given document type: what information is required, what is optional, and in what order it should appear. For an API reference entry, this might mean mandating endpoint, method, description, parameters, authentication, example request, example response, and error codes. For a troubleshooting guide, it might mean symptoms, cause, solution, and prevention. Templates should be paired with writing standards that cover voice, tone, terminology, and accessibility, and they should be stored where contributors can find them easily.
Establish review workflows that separate concerns. A single “please review this doc” request is inefficient because it dumps multiple types of feedback onto a single reviewer. A better approach is to design a workflow with distinct stages: a technical review for accuracy, an editorial review for clarity and tone, and a final check for formatting and compliance. Each stage should have clear owners and criteria. For example, the technical review might be owned by the engineering lead who wrote the feature, while the editorial review is owned by a senior writer or editor. This separation prevents reviewers from being overwhelmed and ensures that each type of feedback gets the attention it deserves.
Align documentation with cross-functional content types. Documentation does not exist in isolation. Marketing content, support articles, in-product UI text, training materials, and sales enablement docs all contribute to the user experience, and when they contradict each other, user trust erodes. At the senior level, part of your role is to map these content types, identify ownership, and establish shared terminology and style standards across teams. This might mean creating a cross-functional content council, running alignment workshops, or simply maintaining a shared glossary that all teams reference. The goal is to ensure that a user who reads a marketing white paper, then a support article, then the API docs, encounters consistent terminology, tone, and structure.
Build training and onboarding into the system. Standards and templates are only useful if people know they exist and understand how to use them. This means creating onboarding materials for new writers and contributors, running regular training sessions on style and process, and making it easy to ask questions without fear of judgment. For engineering teams who contribute docs, this might mean a 30-minute workshop on how to use the templates and what the review process looks like. For junior writers, it might mean a structured mentorship program where they shadow a senior writer through a full documentation lifecycle. The investment in training pays off in reduced review cycles and higher-quality first drafts.
Maintain standards over time through iteration. Documentation standards are not set-and-forget artifacts. They should be reviewed quarterly or biannually, with input from the teams who use them. Metrics like review cycle time, number of style violations caught in CI, and contributor satisfaction can tell you whether your standards are helping or hindering. If a template is consistently ignored, it may be too rigid. If a style rule is constantly debated, it may be unclear. The senior writer’s job is to treat the documentation system as a product: iterate based on feedback, measure impact, and communicate changes clearly when they happen.
5. Publishing and knowledge sharing
Ownership also extends beyond your immediate team and into the wider documentation and technical communication community. This can involve publishing technical analyses or case studies based on real documentation work, where you reflect on decisions, systems, and outcomes rather than just the final output.
It also includes sharing documentation patterns, workflows, and systems that others can learn from or adapt in their own work. In some cases, this takes the form of contributing templates, frameworks, or tooling improvements back into open-source projects.
At this stage, speaking at documentation, developer, or technical writing events becomes another way of sharing practical experience, especially when it is grounded in real systems you have worked on. Mentoring beginner and intermediate writers is also a natural extension of this work, helping them develop not just writing ability but an understanding of how documentation functions in real organisations.
Resources
- Enterprise Data Governance: Frameworks and Workflows for Scale explains how enterprise governance programs are structured across centralized, federated, and hybrid models, and how to assess organizational readiness across six dimensions: data culture, strategic readiness, governance strategy, people and roles, processes, and technology. It breaks down how to establish governance structures with clear roles and how to define policies for classification, access control, quality standards, and retention.
- Template Standardization: Definition, Examples & Best Practices provides documentation use cases for template standardization, including knowledge base articles and process documentation.
- What a Senior Technical Writer ACTUALLY Does explains how senior writers build documentation standards, taxonomy, and workflows, including review processes that separate technical accuracy checks from clarity editing. It notes that without standards and taxonomy, docs turn into a maze, and that senior writers are expected to manage ambiguity by asking targeted questions, building draft structures, and pulling stakeholders into alignment rather than waiting for perfect information.
- Technical Writing Management defines the responsibilities of a technical writing manager, including hiring and supporting a world-class team, balancing assignments across the team to prevent over-resourcing, helping writers refine skills through editorial feedback, and defining processes that align with product and engineering goals.
- Technical Writing Manager: Definition, Responsibilities, Job Description explains how a technical writing manager acts as both a communication manager and a technical documentation manager. It breaks down how this role involves hiring high-caliber writers, knowing each employee’s strengths and weaknesses, distributing assignments based on individual characteristics and workload, and aligning team effort with company strategy.
- Document workflow management: A practical guide explains how to monitor document workflows using metrics like processing time, approval speed, and retrieval time, and how to optimize using templates and automated checks.
- Data Governance Policy Template & Guide offers a complete governance policy template that can be adapted for documentation standards, covering purpose, scope, governance roles and responsibilities, classification, quality requirements, training and awareness, and review cadence. It demonstrates how to structure policy documents so they are actionable and maintainable over time.
- Tools for Collaborating in Technical Writing Teams outlines how to improve collaboration beyond tools alone by establishing clear roles, creating shared style guides, adopting version control systems, centralizing communication channels, and making feedback a normalized part of the process. It emphasizes encouraging early edits and reviews rather than late-stage revisions, and having clear guidelines for revision cycles to prevent endless review loops.
10. Career paths and staying current
Senior technical writers move into a range of roles as they develop. Common directions include:
- Documentation Engineer
- Developer Advocate
- API or Platform Documentation Specialist
- Editorial Lead or Documentation Manager
- Documentation Strategist or Information Architect
WriteTech Newsletter covers technical writing job opportunities, community updates, and industry developments. It is particularly useful if you are actively looking for roles or tracking how the field is changing.
Capstone deliverable: Docs Programme Pack
The capstone for this level is not a single document. It is a documentation programme proposal built from an existing system, similar to what a technical writer would do when joining a team, auditing existing documentation, or being asked to improve a live system.
You are expected to work with an actual documentation source. This can be one of the following or any source of your choice:
- An open-source project (for example Mautic, Wagtail, or Flask), or
- A product with public documentation (for example Notion, OpenWeather API docs)
Your goal is to evaluate, restructure, and design improvements based on what already exists.
Your Docs Programme Pack should include:
Content strategy (two to three pages): Based on the existing documentation, define the intended audience, scope boundaries, ownership model, content standards, and deprecation policy. Your decisions must reflect what the system actually contains today, not what you assume it should contain.
Governance model: Define how documentation is created, reviewed, and maintained within the context of the existing project. This includes roles, review workflows, contribution guidelines, and how issues are handled when documentation breaks, becomes outdated, or is missed in the release process. Your model should feel realistic for the size and structure of the system you selected.
Information architecture proposal: Produce a redesigned sitemap based on the current structure of the documentation you chose. Include a definition of the content types currently present (or missing but needed), and explain your structural decisions using evidence from the existing documentation, such as duplication, unclear navigation, or inconsistent page goals.
Metrics plan: Define what you would measure if you were responsible for improving this documentation in production. Your metrics must be tied to real user behaviour you can reasonably infer from the system (for example search gaps, navigation issues, or support questions), not abstract assumptions. Explain how each metric would be collected and what improvement would look like in practice.
Automation plan: Describe how you would introduce or improve automation in the existing documentation workflow. This should include CI checks (such as build validation, link checking, and linting with Vale), template improvements, and any API or reference automation already available in the system (such as OpenAPI-generated docs, if applicable). Your plan should reflect what is realistically possible within the current constraints.
What this is testing
This capstone is designed to reflect what technical writers actually do in real teams. You are evaluating existing systems, identifying gaps, and designing improvements that fit real constraints such as tooling, team structure, and product maturity.
Strong submissions will show that you can work with imperfect systems, make structured decisions based on evidence, and design documentation programmes that could realistically be handed to an engineering or product manager for implementation.
Important constraint
This work should clearly reflect analysis of an existing documentation system, not AI-generated content for a fictional product. The quality of your submission will depend on how well you interpret real documentation, identify problems, and justify your design decisions using evidence from what already exists.
Submission format
Your Docs Programme Pack should be submitted as a public GitHub repository.
The repository should be structured like a real documentation project, not a single document dump. Each part of the capstone should be clearly separated into its own file so that someone reviewing your work can understand your thinking step by step.
At minimum, your repository should include a README.md that explains:
- The documentation system or project you selected
- What part of the documentation you analysed (for example full docs, a section, or a feature area)
- How to navigate your submission
- Any assumptions or limitations you worked with
Each component of the Docs Programme Pack should be written in Markdown files, for example separate files for content strategy, governance model, information architecture, metrics plan, and automation plan.
Your information architecture should include a visual or structured sitemap. This can be written in Markdown using nested lists or diagrams using tools like Mermaid if you are comfortable with them.
You are encouraged to use a docs-as-code workflow for this project. This means your work should include versioned commits, and optionally pull requests if you want to simulate a real team environment. You should also include a basic CONTRIBUTING.md if you are treating the repository as a maintained documentation project.
Finally, your submission should be shared for feedback. You should post it in the WriteTech Hub community and, where possible, request a review from another writer or mentor.