Learning Roadmap
How to Become a AI Technical Writer
A step-by-step, phase-based learning path from beginner to job-ready AI Technical Writer. Estimated completion: 7 months across 5 phases.
Progress saved in your browser — no account needed.
-
Foundations of Technical Writing & Programming Basics
6 weeksGoals
- Master clear, structured technical writing principles
- Learn Python and JavaScript fundamentals sufficient for reading and writing code samples
- Understand REST APIs, HTTP methods, JSON, and authentication patterns
- Set up a Git-based documentation workflow with Markdown
Resources
- Google Technical Writing Courses (free, online)
- MDN Web Docs - HTTP and REST fundamentals
- freeCodeCamp - JavaScript and Python basics
- Pro Git book (Chacon & Straub) - Git fundamentals
MilestoneYou can write a clear, well-structured getting-started guide for a simple REST API, complete with tested code samples in Python and JavaScript, stored in a Git repository.
-
AI/ML Concepts & LLM Literacy
6 weeksGoals
- Understand transformer architecture, tokenization, embeddings, and vector databases at a conceptual level
- Learn prompt engineering techniques: zero-shot, few-shot, chain-of-thought, system prompts
- Explore RAG architectures, fine-tuning, and agents/workflows
- Gain hands-on experience with OpenAI API, Hugging Face, and LangChain
Resources
- Andrej Karpathy - 'Intro to Large Language Models' (YouTube)
- Hugging Face NLP Course (free)
- OpenAI Cookbook (GitHub)
- LangChain documentation and tutorials
MilestoneYou can explain and document how a RAG pipeline works, including embedding generation, vector storage, retrieval, and augmented generation - and write a tutorial that walks a developer through building one.
-
Docs-as-Code & Developer Experience
5 weeksGoals
- Build documentation sites using Docusaurus, MkDocs, or ReadMe
- Implement OpenAPI/Swagger for API reference generation
- Learn information architecture for developer portals
- Practice writing for different documentation types: conceptual, how-to, reference, tutorial
Resources
- Docs Like Code by Anne Gentle
- Docusaurus official tutorial
- Redocly or Swagger UI for OpenAPI rendering
- Diátaxis documentation framework
MilestoneYou can build a fully functional documentation site with auto-generated API references, conceptual guides, tutorials, and a logical navigation structure - deployed via CI/CD.
-
AI-Specific Documentation & Tool Mastery
5 weeksGoals
- Document complex AI workflows: multi-model pipelines, agent orchestration, evaluation loops
- Master AI-assisted documentation workflows using LLMs for drafting and review
- Write prompt engineering guides and template libraries
- Create architecture diagrams for AI systems using Mermaid.js or Excalidraw
Resources
- OpenAI Platform documentation (study their structure and patterns)
- Anthropic Claude documentation (study their style)
- AWS SageMaker and Bedrock documentation
- Mermaid.js documentation and tutorials
MilestoneYou can independently produce a complete documentation suite for an AI developer tool, including API references, conceptual explainers, quickstarts, prompt libraries, and architecture diagrams.
-
Portfolio Building & Job Preparation
4 weeksGoals
- Build 3-5 portfolio projects demonstrating end-to-end AI documentation skills
- Contribute documentation to open-source AI projects (LangChain, LlamaIndex, Hugging Face)
- Develop a personal documentation site showcasing your work
- Prepare for technical writing interviews with AI focus
Resources
- GitHub - open-source contribution guides for major AI frameworks
- Write the Docs community and conferences
- Technical writing portfolio best practices (I'd Rather Be Writing blog)
- LinkedIn and networking within AI developer communities
MilestoneYou have a polished portfolio with open-source contributions, original documentation projects, and a personal site - ready to apply for AI Technical Writer roles at AI companies and developer platforms.
Practice Projects
Apply your skills with hands-on projects. Ordered by difficulty.
OpenAI-Compatible API Documentation Suite
BeginnerCreate a complete documentation site for a mock AI chat completion API, including API reference (OpenAPI spec), quickstart guide, code samples in Python/JS/cURL, error handling guide, and a getting-started tutorial. Deploy using Docusaurus or MkDocs.
RAG Pipeline Tutorial and Documentation
IntermediateWrite a comprehensive tutorial that guides developers through building a retrieval-augmented generation pipeline using LangChain, a vector database (Pinecone or Chroma), and an LLM API. Include conceptual explanations, architecture diagrams, code walkthroughs, and troubleshooting guides.
Open-Source Contribution to an AI Framework
IntermediateContribute meaningful documentation improvements to an open-source AI project such as LangChain, LlamaIndex, or Hugging Face Transformers. This could include missing API references, tutorial improvements, getting-started guides, or documentation bug fixes.
Prompt Engineering Template Library & Documentation
IntermediateCreate a documented library of 20+ prompt engineering templates (few-shot, chain-of-thought, role-based, structured output, etc.) with usage guides, best practices, and integration examples using the OpenAI API. Publish as a GitHub repository with a companion documentation site.
Multi-Model API Comparison Documentation
AdvancedCreate a comprehensive documentation portal that compares and documents usage patterns across multiple AI providers (OpenAI, Anthropic, Google, Cohere, Mistral). Include unified quickstarts, provider-specific references, migration guides, and a decision framework for choosing models.
AI Developer Portal with Interactive Playground
AdvancedBuild a full developer portal for a fictional AI platform using Mintlify, Fern, or ReadMe. Include auto-generated API references from OpenAPI specs, interactive API playground, conceptual guides, SDK documentation, changelogs, and a feedback mechanism. Implement CI/CD for documentation updates.
Ready to Start Your Journey?
Prep for interviews alongside your learning — it reinforces every concept.