User Guide

This guide provides comprehensive instructions for technical writers, developers, and product managers using SudoDocs to automate documentation workflows.

You can use the features in two ways:

• Global Tools: The Workspace provides a list of globally available features that you can use without creating a release dashboard. These include the following tools:

  • DocOps Assistant: Bridges the gap between your engineering codebase and your published documentation. By querying your synced code and documentation repositories in real-time, it acts as a technical co-pilot that understands your actual product logic. It streamlines your entire documentation lifecycle—from answering highly technical codebase queries and generating first drafts, to automating release notes and proactively auditing your site for technical drift.
  • Universal Converter: Translates documentation between different markup languages
  • Doc PR Inbox: Generates automated documentation suggestions directly from engineering pull/merge requests.
  • Diagram Generator: Builds brand-compliant Mermaid.js sequence diagrams based on natural language descriptions or visual reference images.
  • API Readiness: Validates your OpenAPI Specifications (OAS) against industry standards and your own style guide.

• Project Tools: The Project dashboard page a set of specialized tools that you would need to work in a release cycle. These include the following tools:

  • Compose Release Notes: Generate consolidated changelogs from Jira or CSVs.
  • Author a Feature: Draft comprehensive feature documentation.
  • Assigned PRs: Allows you to review, edit, and finalize AI-generated documentation drafts before pushing them to production.