Skip to main content

Configure the Knowledge Base

Configure how the SudoDocs AI understands your product terminology, tone, and structure. See CLI Tasks → Knowledge Base for the command-line equivalent of everything on this page.

Set Base Frameworks​

Select a foundational formatting rule set for the AI.

  • Google Developer Docs: Objective and direct.
  • Microsoft Style: Conversational and accessible.
  • Apple Style: Minimalist and user-focused.
  • IBM Style: Strict and enterprise-grade.
  1. Navigate to Admin Dashboard > Knowledge Base.
  2. Choose a framework from the Base Framework dropdown - it saves automatically.

Product Categories​

List your product areas (one per line) to help the AI sort and place content - used by both Compose Release Notes (to bucket items into sections) and Author a Feature's Information Architect step (as a hint when deciding where new content belongs).

  1. On the Knowledge Base tab, find the AI-Learned Classifications card.
  2. Edit the Product Categories box (one category per line, e.g. "API", "Frontend", "Security"). This box is also populated automatically by Auto-Learn, but you can edit it manually at any time.
  3. Click Save Product Categories.

Looking for Deployment Tags or CSV Column Mappings? Those moved to Compose Release Notes - they're specific to Bulk Release Notes generation, not a Knowledge Base concern shared across features the way Product Categories is.

Neural Overrides (Style Guide)​

Define absolute laws for the AI regarding your brand: product ontology and taxonomy, tone and terminology rules, and structural writing instructions - as one free-form Markdown document. This is the mechanism for customizing your style guide on top of whichever Base Framework you selected above.

  1. On the Knowledge Base tab, click Configure Markdown under Neural Overrides.
  2. Paste your content into the text box - typically the combined contents of a product overview, a style guide, and writing instructions, each as its own .md file you already maintain elsewhere. (Scripting this instead? CLI Tasks → Knowledge Base uploads a local file directly.)
  3. Click Save Overrides.

Auto-Learn (below) appends a Auto-Learned Rules section to this same box rather than overwriting it, so anything you've written by hand is preserved.

There's no separate structured field for terminology rules - write them directly into this Markdown document in whatever format you want (e.g. a table, or a list like InternalTerm → PublicTerm); the AI treats the whole document as a strict instruction set, not a specific schema.

Auto-Learn Tone​

The Auto-Learn agent scans your connected documentation and public web repositories to extract your company's writing style and terminology, merging what it finds into your Product Categories and Neural Overrides above rather than replacing them. SudoDocs explicitly ignores code repositories during this process to prevent a robotic tone.

  1. Ensure you have synced at least one Documentation or Web repository.
  2. Navigate to Admin Dashboard > Knowledge Base.
  3. Click Run Auto-Learn.