TechWrit AI — VS Code Extension

Review, rewrite, and simplify technical documentation against your style rules, terminology, and glossary — directly in VS Code.

Features

Review — Get severity-ranked editorial feedback (Critical, Important, Minor) as inline diagnostics. Issues appear as squiggly underlines with quick-fix code actions to apply suggested corrections.

Style Check — Run a structured audit of every active style rule. Violations become diagnostics; the style score percentage displays in the status bar.

Rewrite — Rewrite your document to comply with your style rules. Opens a diff view so you can see exactly what changed before accepting.

Simplify — Reduce reading complexity to Grade 8-10 level. Same diff view UX as Rewrite.

Selection support — Right-click selected text to review or rewrite just that section.

Review on save — Optionally auto-review Markdown files on every save.

Requirements

A TechWrit AI account with a Pro or Team subscription
An API key (create one at techwrit.ai under API Keys in the user menu)

Getting Started

Install the extension from the VS Code Marketplace.
Open a Markdown file.
The status bar shows "TechWrit AI: No API key" — select it or run TechWrit AI: Set API Key from the command palette.
Paste your API key (starts with twai_).
Right-click in the editor and select TechWrit AI: Review Document.

Commands

Command	Shortcut	Description
`TechWrit AI: Review Document`	`Ctrl+Shift+F6`	Review the full document for style issues
`TechWrit AI: Style Check`	`Ctrl+Shift+F7`	Audit every active rule with a style score
`TechWrit AI: Rewrite Document`	`Ctrl+Shift+F8`	Rewrite to comply with style rules
`TechWrit AI: Simplify Document`	`Ctrl+Shift+F9`	Simplify for readability
`TechWrit AI: Review Selection`		Review selected text only
`TechWrit AI: Rewrite Selection`		Rewrite selected text in-place
`TechWrit AI: Set API Key`		Configure your API key

Settings

Setting	Default	Description
`techwrit.baseUrl`	`https://techwrit.ai/api`	API base URL
`techwrit.audience`	(empty)	Default audience: consumer, engineers, developers, or devops
`techwrit.docType`	(empty)	Default document type (e.g., "API reference")
`techwrit.reviewOnSave`	`false`	Auto-review Markdown files on save

The API key is stored securely in VS Code's secret storage, not in settings.json.

How It Works

The extension sends your document text to the TechWrit AI REST API, which applies your saved style rules, terminology substitutions, and product glossary. Results are parsed and displayed as native VS Code diagnostics.

API requests share the same monthly quota as the web app. Rate limit information is shown in the status bar tooltip.

TechWrit AI — Technical Writing Assistant

TechWrit AI