User Guide

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

In This Section

• Compose Release Notes: Generate consolidated changelogs from Jira or CSVs.
• Write a Single Release Note Entry: Create a polished entry for a specific ticket: feature, enhancement, bug fix, or a known issue.
• Author a Feature: Draft comprehensive feature documentation.
• Check API Readiness: Validate OpenAPI specifications and upload to ReadMe.
• Generate Reference Docs: Convert Helm Charts and OpenAPI Specs to Markdown.
• Audit Documentation: Detect technical drift between code and docs.
• Product Assistant: Use natural language to query your knowledge base.