Skip to content

Commit d2067c1

Browse files
Plan for VAPICS-186
1 parent 1b60091 commit d2067c1

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

docs/specs/VAPICS-186/PLAN.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Vapi Documentation Writing Bible
2+
3+
**Progressive Structure, Plain Language & Anti-Verbosity Standards**
4+
5+
*Created for Linear ticket VAPICS-186*
6+
7+
---
8+
9+
## Table of Contents
10+
11+
1. [Part 1: Documentation Architecture — Progressive Learning Tree](#part-1)
12+
2. [Part 2: Language & Jargon Standards — Plain English First](#part-2)
13+
3. [Part 3: Content Density & Anti-Verbosity Framework](#part-3)
14+
4. [Part 4: Reusable Doc Page Template](#part-4)
15+
5. [Part 5: AI Agent Brief — Doc Drafting & Review Standards](#part-5)
16+
17+
---
18+
19+
## Introduction
20+
21+
This document defines **how** Vapi documentation should be written. The goal: users self-serve, discover more features, and never need to open a support ticket.
22+
23+
Three principles govern everything:
24+
25+
1. **Progressive structure** — concepts build sequentially, no page assumes knowledge that hasn't been introduced earlier
26+
2. **Plain language** — plain English by default, jargon explained inline, zero assumed knowledge
27+
3. **Anti-verbosity** — every sentence earns its place, docs respect the reader's time
28+
29+
The full document includes the progressive learning tree with dependency graph, language style guide with banned words list, anti-verbosity playbook with scanability checklist, a reusable doc page template, and an AI agent brief for automated drafting/review.

0 commit comments

Comments
 (0)