II.
Workflow overview
Reference · liveworkflow:developer-documentation-review
Developer Documentation Review overview
Structured review workflow ensuring that developer-facing documentation — API references, guides, tutorials, and changelogs — is accurate, complete, and consistent with each release. The documentation engineer audits recently changed APIs against published docs, identifies gaps and outdated examples, and drafts updates. The tech lead reviews technical accuracy while a peer editor checks clarity and structure. Review feedback is addressed before the documentation is published alongside the corresponding release, preventing developer confusion from stale or missing content.
Attributes
displayName
Developer Documentation Review
description
Structured review workflow ensuring that developer-facing documentation — API references,
guides, tutorials, and changelogs — is accurate, complete, and consistent with each
release. The documentation engineer audits recently changed APIs against published docs,
identifies gaps and outdated examples, and drafts updates. The tech lead reviews
technical accuracy while a peer editor checks clarity and structure. Review feedback is
addressed before the documentation is published alongside the corresponding release,
preventing developer confusion from stale or missing content.
workflowKind
development
triggerType
event-driven
typicalCadence
per-release
complexity
moderate
Outgoing edges
applies_to_domain1
- domain:software-engineering·DomainSoftware Engineering
involves_role4
- role:documentation-engineer·RoleDocumentation Engineer
- role:tech-lead·RoleTech Lead
- role:technical-writer·RoleTechnical Writer
- role:backend-engineer·RoleBackend Engineer
Incoming edges
lib_implements_workflow2
- lib-process:technical-documentation--docs-audit·LibraryProcessspecializations/technical-documentation/docs-audit
- lib-process:technical-documentation--docs-pr-workflow·LibraryProcessspecializations/technical-documentation/docs-pr-workflow
supports_work5
- tool:tavily·ToolTavily
- tool-server:mcp-docusaurus·ToolServerDocusaurus MCP Server Plugin
- tool-server:mcp-confluence·ToolServerConfluence MCP Server
- tool-server:mcp-tavily·ToolServerMCP Tavily
- tool-server:mcp-gitbook-candidate·ToolServerGitBook MCP candidate