Voice for Onboarding Docs

Create onboarding documentation by explaining your codebase and processes aloud. Help new hires ramp up faster with documentation written by those who know it best.

The Problem

Onboarding documentation is almost always incomplete, outdated, or nonexistent. The people who know the codebase best are too busy to write docs, and new hires waste weeks piecing together tribal knowledge from scattered Slack messages and code comments.

The Solution

Ummless lets experienced team members brain-dump their knowledge by simply talking. Walk through the codebase, explain conventions, and describe processes out loud. The Technical Documentation preset turns these explanations into structured onboarding guides.

Workflow

  1. Identify knowledge gaps

    Think about what a new hire would need to know on day one. What questions do new people always ask?

  2. Open Ummless

    Select "Technical Documentation" to generate structured, navigable documentation.

  3. Walk through the codebase

    Explain the project structure, key modules, how to run the dev environment, and common gotchas. Speak as if you're sitting next to a new teammate.

  4. Cover processes

    Describe your team's development workflow: branching strategy, code review process, deploy pipeline, and communication norms.

  5. Organize and publish

    Review the outputs, organize them into logical sections, and publish to your team wiki or docs site.

Before & After

Raw Transcript

So when you first clone the repo you need to run bun install at the root because it's a monorepo managed by Turborepo. The main apps are in the apps folder, there's a desktop app built with Tauri and a web app built with Next.js. The shared packages are in packages, the most important one is packages/convex which has all the database stuff. To run the dev server you do bun run dev and it starts everything. Oh and you need to create a dot env file based on dot env example, you need Clerk keys and a Convex deployment URL.

Refined Output

## Developer Onboarding Guide ### Initial Setup 1. Clone the repository 2. Run `bun install` at the project root (monorepo managed by Turborepo) 3. Copy `.env.example` to `.env` and configure: - Clerk API keys - Convex deployment URL 4. Run `bun run dev` to start all services ### Project Structure | Directory | Description | |-----------|-------------| | `apps/desktop` | Desktop application (Tauri + React) | | `apps/web` | Web application (Next.js) | | `packages/convex` | Database schema and server functions | | `packages/` | Shared packages (UI components, config, types) | ### Key Concepts - **Turborepo** manages the monorepo build pipeline and task dependencies - **Convex** (`packages/convex`) contains all database schemas and server-side functions - Both apps share UI components and configuration from the `packages/` directory

Suggested Presets

Technical Documentation

Frequently Asked Questions

How often should I update onboarding docs?

Whenever something changes that would trip up a new hire. With Ummless, updating is as fast as speaking the change aloud. Make it part of your workflow when you modify setup steps or conventions.

Can new hires contribute to the docs?

Absolutely, and they should. New hires are the best judges of what's missing. Have them dictate their confusion points and solutions via Ummless to keep the docs improving.

Ready to try it?

Download Ummless and start using voice for your workflow.

Related Content