Getting Started with Onvoke
A step-by-step guide to generating documentation using Onvoke’s AI-powered knowledge base platform.
Getting Started with Onvoke
Welcome! In this guide, we’ll walk you through how simple it is to create documentation using Onvoke, your AI-powered knowledge base and documentation platform.
Step 1: Sign Up and Access the Workspace
To begin, you’ll need a valid license.
If you’re interested in a free trial, just send us an email—we’d love to get you started.
Once you're signed up and logged in, you'll land on your Onvoke workspace. This is where you create and manage your documentation.
Step 2: Fill Out the Content Brief
You’ll see a field called Content Brief. This is a prompt where you tell the AI what kind of documentation you want to create.
Example:
“Create a step-by-step SOP on generating shipping labels using our internal dashboard.”
Step 3: Attach Supporting Files (Optional)
If you have supporting documents—like PDFs or DOCX files—you can attach them here.
Onvoke will use the content from these files as context when generating the documentation.
Step 4: Select a Template
Upon your first login, you’ll see three built-in templates:
- Process Design
- Document SOP
- User Manuals
Choose one that fits your use case. For this example, let’s select User Manual.
💡 You can also create custom templates — we’ll cover that in another guide.
Step 5: Choose Sources
You can configure sources like Jira, Confluence, Notion, Drive, etc.
Once configured, you’ll be able to pull information from these platforms automatically.
For now, let’s say we’ve selected Jira and Notion as sources.
Step 6: Capture Your Workflow
Click on Capture. This launches the Onvoke browser extension.
- Click Start
- Navigate through your SaaS application
- Perform the workflow you want documented
The extension will record your interactions and track screen activity in the background.
Step 7: Set Generation Preferences
Before generating your document, you can choose:
- Detail Level: Low, Medium, or High
- Formality: Informal, Neutral, or Formal
Pick what best suits your audience.
Step 8: Generate Documentation
Click Generate and let Onvoke work its magic.
It’ll combine your content brief, files, templates, sources, and workflow recordings to create a context-rich, professional document.
Output Example
Navigate to the Articles section to view your documentation.
A typical output includes:
- Title
- Table of Contents
- Introduction
- Prerequisites
- Step-by-step Instructions
- Screenshots
- Feature Highlights
Unlike generic how-tos, Onvoke’s documentation includes deep context and AI-curated insights.
Why Onvoke Stands Out
- Generates context-aware documentation
- Automatically pulls from multiple tools (Jira, Drive, Notion, etc.)
- Tracks and records workflows via extension
- Includes support for SOPs, training manuals, help articles, and more
Try Onvoke
Ready to try it out?
Send us an email and we’ll set you up with access.
We’re excited to help you build better documentation—automatically.