Skip to main content

draft-feature-doc

Draft a new feature documentation page or update an existing one. This is the most common page type in Warp's docs (~75+ pages). Feature docs combine conceptual content (what a feature is and how it works) with procedural content (step-by-step usage instructions) in one page.

Informations de source

Dépôt
warpdotdev/docs
Dernière activité de la source
28 août 2026 à 18:38
Langue détectée de SKILL.md
anglais
Étoiles
44
Forks
27

Options d'installation

Le prompt qui vérifie d'abord la source est sélectionné par défaut. Vous pouvez passer à une commande directe ou télécharger une copie locale.

Vérifiez les fichiers source

Lisez SKILL.md et les fichiers associés affichés par SkillsMP avant de décider de l'installer.

Affichage de SKILL.md

SKILL.md
Instructions source · Aperçu en lecture seule
name
draft_feature_doc
description
Draft a new feature documentation page or update an existing one. This is the most common page type in Warp's docs (~75+ pages). Feature docs combine conceptual content (what a feature is and how it works) with procedural content (step-by-step usage instructions) in one page.
# Draft feature documentation page Draft a feature documentation page that combines conceptual and procedural content — explaining what a feature is, then showing how to use it. ## Workflow Follow the workflow in `.agents/skills/draft_docs/SKILL.md`, using the **feature-doc template** at `.agents/templates/feature-doc.md`. ## Frontmatter description One to two sentences, 50-160 characters, saying what the feature does and its primary benefit. - ✅ `Control what the agent can do with permission cards, auto-approve, and execution profiles.` - ❌ `Documentation for permissions and profiles.` See "Descriptions by content type" under Frontmatter in `AGENTS.md` for the full rules. ## Content type rules These rules are specific to feature documentation pages (from the "Drafting by content type" section of `AGENTS.md`): - Apply the **conceptual** rules to the explanatory sections (explain what and why, define terms, no procedures in the overview). - Apply the **procedural** rules to the step-by-step sections (motivate steps, expected outcomes, focused steps). - **Keep the conceptual and procedural sections clearly separated with distinct headers.** Don't let explanation creep into procedures or vice versa. - Title convention: feature name as noun - Apply the tone rules in AGENTS.md → Voice & tone: no marketing buzzwords or meta-openers, and no internal architecture the reader can't act on. Run a deletion-only "Cut again" pass before presenting the draft — a short page is a finished page. ## Heading case All headings (H1–H4) must use **sentence case**: capitalize only the first word and proper feature names. - ✅ `## How it works` - ✅ `## Configuring your environment` - ✅ `## Agent Mode settings` ("Agent Mode" is a proper feature name) - ❌ `## How It Works` - ❌ `## Configuring Your Environment` - ❌ `## Agent Mode Settings` ## Product name variables For any product name in `src/data/vars.ts`, use the variable — never hardcode the string. The template already includes the `[VARS]` instruction block that shows exactly where to add the import. Key reminder: - Prose: `{VARS.WARP_AGENT_CLI}` (not "Oz CLI") - Frontmatter title/description: `{{WARP_AGENT_CLI}}` ## Existing examples Read 2-3 of these strong examples to match the existing pattern: - `src/content/docs/agent-platform/capabilities/skills.md` - `src/content/docs/platform/environments.md`
Voir sur GitHub