Hypothesis
- With the booming of API usage, developer experience is becoming a priority amongst tech companies. Many companies maintain their own team to build developer portals. Startups and SMEs don’t have the resources (or just not their focus for the time being) to maintain such a team.
- Bad experience (lack of tools to assist productivity and advanced writing) when writing documentation, therefore less desire to write.
- Developers spend hours reading documentation, that could have been spent on actually developing products.
Proposal
- Bring the documentation toolchains of big tech companies to startups, open-source projects, and SMEs.
- Provide tools to assist writing for advanced use cases and boost productivity for technical writers.
- Renovate the documentation to make it more interactive, more personal, and easier to use/read; therefore boost productivity for developers.
Market
A big enough company should have its own process of writing/publishing documentation that may have been optimised enough. Overread’s focus will be on startups (or open-source projects) and SMEs.
Who is the end user?
Ultimately, Overread would eliminate the need for Developer Experience Engineers, and help Developer Experience (DevExp) team.
Requirements
- Allow users to select themes for their documentation.
- Doc-as-code deployment flow.
Features
- Login via GitHub
- Build Markdown projects with theme locally
- Create a project with GitHub
- Delete project
- Deploy project to AWS
Roadmap
- Smart search: Q&A with a chatbot to find code examples, summarise API usage, answer question about internal processes (help with onboarding).
- VSCode extension to assist with writing. No such solution exists before, which makes writing on VSCode painful. Can be something like Notion AI.
- Authentication for internal documentation or context-based documents.