To initiate the first-pass creation of your technical documentation, navigate to the Creator module in the Admin Portal’s main menu. Ozgar AI will guide you through a structured, four-step workflow to configure and generate comprehensive, AI-powered documentation tailored to your project’s knowledge base.

For generating documentation, Ozgar AI needs some basic inputs about the documentation to be generated. There are 4 steps to follow:

1) Define the Outline

  • Select Topics

    • Choose from the predefined checklist of documentation sections (e.g., Architecture Overview, API Reference, Data Models).

    • Optionally, enter custom topics in the free-text field to cover any additional areas.

  • Generate

    • Click Generate Outline.

    • Ozgar AI uses these selections as the foundation for the initial document structure.

612.png

2) Refine the Outline

  • Customize Structure

    • Review the draft outline displayed on the left pane.

    • Add, remove, or reorder sections by entering explicit instructions in the Instructions panel.

  • Refresh Outline

    • Enable or disable any guidance you’ve provided to the LLM.

    • When ready, press Refresh Outline to apply your updates.

  • Continue

    • Once the outline accurately reflects your requirements for the documentation, click Continue.

623.png

3) Configure Languages

  • Default Support

    • English is included automatically.

  • Add Additional Languages

    • Select one or more target languages from the dropdown list (e.g., German, Spanish, Japanese).

  • Save and Continue

    • Click Save and Continue to lock in your language settings and initiate the documentation generation.

633.png

4) Generate Pages

  • Automated Generation

    • Ozgar AI will create individual documentation pages for each outline section in every selected language.

    • Typical processing time ranges from 15 to 30 minutes, depending on the project’s scope.

641.png

5) Review & Preview Documentation Pages

Upon completion, the outline reappears. Click any section title in the outline to view a live preview of the generated page.

650.png