Resources
Practical tools and systems built from 8+ years of professional documentation work. Choose the resource that matches where you are right now.
AI Documentation Toolkits
For people exploring technical writing as a career or trying to get their first role.
A practical guide to breaking into technical writing: what the role actually involves, the tools you need to know, how to build a portfolio with no work experience, and how to land your first job.
Get the Ebook →Practical AI workflows for technical writers who want a more consistent documentation process.
Five reusable workflows based on documentation work. They work with ChatGPT, Claude, Gemini, and other AI assistants.
For technical writers and documentation leads working in git-based repositories who want consistent AI workflows across a team.
A three-layer system that brings AI into the documentation workflow, from planning and drafting to review and release. It lives in your repository so the process stays consistent as your team grows.
For teams maintaining documentation in multiple languages who want a more reliable translation workflow.
A structured system for translating documentation with change detection, glossary management, and human review built into the process. It helps teams automate repetitive translation work while keeping control over terminology and quality.
Requires: Git-based doc repository · GitHub Actions · Python 3.x · OpenAI API key (or any translation API)
For documentation leads and teams preparing their docs for AI tools, including coding agents, copilots, and RAG systems.
A seven-phase framework for improving how AI tools discover, read, and use documentation. It covers benchmarking, machine-readable delivery, content structure, agent instruction files, AI-assisted workflows, maintenance, and measurement. Includes a real-world case study showing how one team improved their benchmark score from the high 50s to the mid-70s.
Research is one of the most sought-after skills for technical writers. This covers how to conduct thorough research, identify reliable sources, and organise your findings for accurate, high-quality documentation.
Read article →
UX writing shapes how users experience products. This covers the principles, techniques, and practical skills you need to write microcopy that guides users through interfaces clearly and confidently.
Read article →
Style guides are one of the most important tools in a technical writer's toolkit. This covers what they are, why they matter, and how to use them to produce consistent, professional documentation.
Read article →
SEO isn't just for marketing — it's essential for documentation too. This covers how to apply SEO principles to technical content so the right readers find what they need, faster.
Read article →
Docs as Code brings software engineering practices — version control, CI/CD, and code review — to documentation workflows. This guide walks you through the tooling, philosophy, and setup from scratch.
Read article →
Documentation is infrastructure, not an afterthought. This explores how effective docs accelerate onboarding, reduce support load, and become a competitive advantage for engineering teams.
Read article →
Open source is not just for engineers. This guide shows technical writers how to find projects that need documentation help, make their first contribution, and build a portfolio through community work.
Read article →
Writing for the wrong audience is one of the most common documentation failures. This covers how to identify, research, and adapt your writing for the people who will actually use what you create.
Read article →
A practical guide to deploying a robust RESTful API using Ambassador Edge Stack and Amazon EKS, covering ingress configuration and routing.
Read article →How to build a collaborative and agile development environment with effective communication, agile methodologies, and automation.
Read article →
Answers to the most frequently asked questions about Git and GitHub for developers getting started with version control.
Read article →How popular DevOps tools and platforms streamline software delivery, automate processes, and improve collaboration across engineering teams.
Read article →Whether you need a senior writer, a documentation strategy, or a consultant. Let's talk.
