Creates comprehensive REST API documentation in OpenAPI/Swagger: paths, schemas, security, examples. Documents API design conventions: naming, pagination, filtering, error format. Configures Swagger UI / Redoc for interactive documentation.
Roles · Technical Writer · Mid-level
What a Mid-level } should know
10 core skills, 45 in total. Expectations per skill, and what changes at the next level.
This page lists what a Mid-level } is expected to know and do, skill by skill. Core skills are the ones a manager and peers assess in a review cycle; the rest count only in self-assessment. Main areas: API & Integration, Version Control & Collaboration, Documentation.
Core skills for a Mid-level
Grouped by area. The label on the right is the expected depth: Awareness, Working, Advanced or Expert.
API & Integration · 1
Version Control & Collaboration · 1
Fully works in docs-as-code workflow: branch, write, PR, review, merge, deploy. Configures CI/CD for automated documentation building and publishing. Uses linting (markdownlint, vale) for text quality control.
Documentation · 8
Writes comprehensive API guides: quickstart, authentication flow, error handling, use cases. Creates code samples in multiple languages (curl, Python, JavaScript, Go). Maintains terminology and style consistency across all API docs sections.
Creates comprehensive architecture documentation with architects: system context, container diagrams, component diagrams (C4). Documents data flows, external system integrations, deployment topology. Keeps documentation up to date.
Creates complex technical diagrams: C4 model (all 4 levels), data flow diagrams, state machines, ER diagrams. Uses diagrams-as-code tools (Mermaid, PlantUML). Maintains visual consistency and diagram readability.
Confidently works with 2-3 docs-as-code frameworks. Configures navigation, search, versioning, custom components. Uses MDX/RST extensions, plugins for diagrams, code highlighting. Integrates docs build into CI/CD.
Designs knowledge base information architecture: taxonomy, navigation, search optimization. Creates content governance: templates, naming conventions, review processes. Ensures content freshness through scheduled reviews.
Independently creates runbooks for production systems: deployment procedures, incident response, disaster recovery. Ensures step-by-step clarity and unambiguity of instructions. Conducts dry-run testing of runbooks with the operations team.
Regularly writes technical posts: deep-dive articles, comparison articles, best practices guides. Optimizes content for SEO and developer audience. Works with CMS (WordPress, Ghost, dev.to). Creates content plans for engineering blogs.
Creates comprehensive user documentation: information architecture, content hierarchy, cross-references. Writes for different audiences (beginners, advanced users, admins). Uses user feedback to improve documentation.
Additional skills
Not assessed by the team, but part of the self-assessment and the development plan.
What changes at Senior
45 skills get a higher expectation or become core when moving from Mid-level to Senior. The biggest jumps first.
- API Documentation Writing: Working → Advanced
- Architecture Documentation: C4, arc42: Working → Advanced
- Diagramming: Mermaid, PlantUML, D2: Working → Advanced
- Docs-as-Code: MkDocs, Docusaurus, Antora: Working → Advanced
- Documentation as Code: Working → Advanced
- Knowledge Base Management: Working → Advanced
- REST API Design: Working → Advanced
- Runbook & Playbook Writing: Working → Advanced
- Technical Blogging: Working → Advanced
- User Documentation: Working → Advanced
} in the open competency matrix: 45 skills across 5 levels. The matrix is free for individuals and stays free.