Introduction to self-updating help docs
Solo helps you keep your knowledge base up to date with your product. When developers merge code or update task tickets, Solo identifies out-of-date documentation. It generates specific action items to update text or images, which you can review and apply directly to your connected help center.
You can also write new documentation from scratch or run manual tasks to update multiple articles based on specific product changes.
Documentation page
The Documentation page gives you a central view of all your synced help articles.
View existing documentation: Browse or search your imported articles. You can see which articles have pending action items, view their source, and check their publish status.
Write new documentation: Select the option to create a new article. You can manually write the content using the built-in editor or provide a topic and instructions to generate a draft based on your product.
Action items page
The Action items page aggregates all pending suggestions across your entire knowledge base.
When action items appear: Action items are created automatically when product changes make your existing articles inaccurate. They also appear when you manually run a documentation task.
Assignee: Each action item can be assigned to a specific team member. You can filter the page to view only the items assigned to you.
Text vs. Image type: Action items are categorized by what needs updating. Text updates suggest replacement wording for outdated paragraphs. Image updates flag screenshots that may no longer match the current product behavior.
Learn more about action items here
Article page
When you open a specific article, go to the Review Mode tab to see action items specific to that page.
Action item cards
Action items appear as individual cards displaying the old content and the new suggested change. You can use the following buttons on each card to manage the suggestion:
Accept: Applies the suggested update to the article.
Add to Draft: Saves the suggestion to a draft version without immediately publishing it to your help center.
Reject: Dismisses the suggestion and removes the action item.
Resolved externally: Marks the item as handled if you updated the documentation outside of the system.
Snooze: Select the timer icon to hide the action item until a specified date or until a feature rolls out.
Comments: Select the chat icon to open a thread and discuss the suggestion with your team.
View source
To understand why a suggestion was made, select View source from the menu on the action item card. This shows the specific code changes, pull requests, or connected task tickets that triggered the update. Reviewing these sources provides context on the product change so you can confidently approve the documentation update.
Manage projects and tasks
Organize major documentation overhauls using projects to group related articles and track their completion. Create specific documentation tasks to instruct the AI to draft new content or update existing articles based on your instructions, ticket links, or codebase context.
Tasks page
Use the Tasks page to organize and execute specific documentation updates based on product changes, ticket links, or codebase context.
Create tasks: Provide a task name, description, ticket links, and optional files to instruct the AI on what needs to be updated. You can also choose to pull context directly from your connected codebase.
Select documentation: Choose the specific articles to update based on the task details.
Run and review: Run the task to generate pending action items for the selected articles, which you can then review and apply.
Track status: Monitor the status of your tasks (Completed, In Progress, or Pending manual execution) and see the number of related action items generated.
Learn more about Tasks here
Projects
Solo helps you maintain accurate and current help center articles by connecting directly to your company's codebase and task trackers. As your product evolves, Solo identifies what needs to change and drafts the updates for you.
Image automation
Keep your screenshots current without manual effort. Solo can automatically record and replace outdated images in your documentation when your product's interface or behavior changes.
Learn more about image automation here
Collaborate with your team
Use the built-in editor to write manually or draft content with AI. You can leave comments on specific sections, tag teammates for review, and check the version history of your articles.
Learn more about collaboration features here