AI-assisted doc creation
The project shows a series of assistive creation for technical code documentation platform — from Pull Request to Doc, Code Flow Diagrams, Doc Rules.
Role
AI integration strategy
UX design
Prompt engineering
Duration
3 months (2023 Q2)
Impact
- AI exposure led to a 26.1% conversion rate from free to trial users — demonstrating clear monetization potential
- 62 total workspace enabled AI
- initiative made us cope up with market’s competition
Context
When ChatGPT explode around the year of 2023, our company started to think about how we can stay relevant in the market. Since we are a documentation platform, we started to look at where it make sense to integrate AI, and not just
Identify AI opportunities
We took inspiration on both note-taking platform and code assistant tool to find areas we can integrate AI. They are mostly categorized in 3 areas — creation, instant understanding, and discovery. Here are some of the candidates:
| Name |
Description |
Category |
| Text auto-completion |
Complete current word or phrase while user is typing |
Discovery |
| Improve writing |
Improve written text and phrases with AI |
Creation |
| Code changes to doc⭐ |
Take each feature or release' code changes and turn them into doc |
Creation |
| Topic to doc |
Suggest outline or sections for docs |
Creation |
| Mermaid diagram⭐ |
Help with syntaxes or the diagram itself |
Creation |
| Doc rules⭐ |
Identifying when a written doc can be surfaced base on the content that was written inside |
Discovery |
| Question to doc |
Base on a recent or frequently asked question, user can see answer and select blocks to be included in a doc |
Question, Creation |
| Explain snippets |
Automatically fill-in description for included code blocks |
Creation |
We decided to use prioritization matrix to identify the top 3 items we want to deliver, making sure we are weighing both easy technical implementation and strong user needs.
Pull-request to doc
Instantly create technical code documentation from code changes, along with other additional insights.
Code flow diagrams
Generate visual diagrams to explain your codebase, without needing to know any Mermaid syntax.
Doc rules
AI suggests use cases and triggers for when documentation should appear, ensuring coding guidelines surface at the exact right moment.