Developer Documentation

Design, write, review, and test code samples in developer documentation, including executable examples, explanatory snippets, request and response pairs, placeholders, outputs, language choice, sandboxing, and autogenerated samples. Use when docs include API examples, SDK snippets, CLI commands, config examples, tutorials, or code blocks readers may copy.

Research developer documentation audiences by mapping user goals, learning objectives, business goals, developer traits, user questions, personas, user stories, journey maps, and friction logs. Use when planning docs for APIs, SDKs, platforms, CLIs, developer tools, onboarding guides, SaaS docs, or support-heavy docs before writing or restructuring content.

Draft developer documentation with clear goals, outlines, titles, headers, procedures, scenario walkthroughs, lists, callouts, skimmable structure, and reusable templates. Use when writing or rewriting READMEs, getting-started docs, tutorials, how-to guides, concepts, API guides, troubleshooting pages, migration guides, SaaS topics, or release documentation.

Edit and review developer documentation for technical accuracy, completeness, structure, clarity, brevity, peer feedback, technical review, technical verification, QA procedure testing, and feedback integration. Use when reviewing, editing, refactoring, or preparing developer docs for release, especially docs with procedures, examples, prerequisites, or high-risk technical claims.

Plan developer documentation by choosing content types, defining scope, making documentation decisions, researching features, planning scenarios, and turning user needs into a practical documentation plan. Use when planning READMEs, getting-started guides, concepts, tutorials, how-to guides, API references, troubleshooting docs, changelogs, release notes, Agile docs work, or multi-doc launch plans.

Research product and feature facts for developer documentation by mapping source-of-truth owners, validating behavior hands-on, interviewing SMEs, and turning uncertainty into doc-ready notes. Use when feature specs are incomplete, implementation details need user-facing meaning, SMEs disagree, or docs require evidence before planning, drafting, release notes, API docs, tutorials, scenarios, or troubleshooting content.

Integrate documentation work with Agile product development by making docs visible in sprint planning, release trains, definitions of done, review timing, and retrospective improvement. Use when docs are missing from scrum boards, stories, acceptance criteria, release planning, or cross-team work, or when writers need a lightweight process for documentation inside Agile teams.

Gather, classify, prioritize, respond to, and act on developer documentation feedback from page feedback, support issues, community forums, field notes, sentiment, surveys, user councils, bug reports, and user follow-up. Use when setting up docs feedback channels, triaging docs issues, responding to frustrated users, prioritizing doc fixes, or converting feedback into actionable documentation work.

Manage developer documentation release, publishing, ownership, freshness, automation, maintenance, SaaS cadence, deprecation, deletion, redirects, and migration alongside software changes. Use when planning docs for a release, defining docs ownership, creating publishing checklists, setting up freshness checks, refreshing existing content, documenting SaaS releases, or retiring stale documentation.

Audit, organize, and redesign developer documentation information architecture, including content inventory, navigation, landing pages, sequences, hierarchies, webs, breadcrumbs, sidebars, metadata, redirects, migration, platform/tool selection, and maintainable IA decisions. Use when restructuring docs sites, improving findability, planning doc migration, evaluating docs tooling, or organizing large documentation sets.

Evaluate documentation platforms and authoring tools by requirements, workflow fit, migration risk, content model, search, integrations, portability, support burden, and cost. Use when choosing docs-as-code, CMS, wiki, DITA, API reference, static-site, help-center, or custom docs tooling, planning a migration, or deciding whether tooling will fix documentation problems.

Audit and measure developer documentation quality using functional quality, structural quality, accessibility, purpose, findability, accuracy, completeness, clarity, concision, consistency, analytics, user goals, doc goals, and metric plans. Use when evaluating docs, designing documentation metrics, selecting dashboards, or linking docs work to user and business outcomes.

Plan and write SaaS documentation for managed services, continuous releases, provider/customer responsibility boundaries, UI/browser constraints, runbooks, support enablement, and release readiness. Use when documenting cloud products, hosted services, admin consoles, fleet-wide changes, service operations, incident or runbook procedures, SaaS release notes, customer-controlled settings, or internal docs that support customer experience.

Design and review visual content for developer documentation, including screenshots, architecture diagrams, boxes-and-arrows diagrams, flowcharts, swimlanes, video decisions, accessibility, performance, annotations, and visual maintenance. Use when creating or auditing diagrams, screenshots, visual explanations, or media in technical docs.