Overview
As your product evolves, identifying and updating all the relevant documentation can be a time-consuming process. Tasks in Solo act as your personal documentation assistant. By describing a product change or sharing a project ticket, Solo scans your knowledge base, identifies the specific articles that need to be updated, and automatically drafts the revisions for you to review.
Create a new task
To start letting Solo update your documentation, you need to create a task.
Navigate to the Tasks section in Solo.
Select Create New Task.
Step 1: Provide task details
In this step, you give Solo the context it needs to understand what has changed.
Task Name: Enter a clear, identifiable name for your task.
Describe the task: Write a clear description of the product change or the objective.
Ticket Links (optional): Provide links to your project management tickets (separated by commas) to give Solo additional context.
Pull from codebase: Toggle this on if you want Solo to read your connected codebase to understand technical changes related to the task.
Add Files (optional): Upload any relevant files or documents that contain information about the change.
Once you fill out the details, select Preview documentation.
Step 2: Review and select documentation
After you submit the task details, Solo searches your knowledge base for articles it believes are impacted by your described changes.
Review Solo's suggestions: You will see a list of articles Solo found. Select the checkboxes next to the articles you want Solo to update.
Add missing articles: If you know an article needs to be updated but Solo did not suggest it, select Missing an article? to search for it manually and add it to your selection.
When you are satisfied with the selected articles, select Run Task.
Review your action items
After you run the task, its status changes to In Progress. Solo is now reading the selected articles and drafting exact text changes based on your task description.
When the task is complete, the status updates to Completed. If you have Slack notifications configured, Solo sends you a direct message.
In the Related Action Items column, you will see the number of updates Solo generated.
Select the number to view the action items. You can then review, accept, or reject the specific revisions Solo drafted for each article.
Edit and re-run a task
If you need to adjust a task after it has been completed, you can edit and run it again.
Select the Actions menu (the three dots) next to a completed task.
Select Edit and re-run task.
Update the details or selected articles and run the task again. Note that re-running a task overwrites any pending action items associated with it.