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.

소스 정보

저장소
warpdotdev/docs
최근 소스 활동
2026년 8월 28일 18:38
감지된 SKILL.md 언어
영어
스타
44
포크
27

설치 방법

기본적으로 소스를 먼저 확인하는 Prompt가 선택됩니다. 직접 명령으로 전환하거나 로컬 사본을 다운로드할 수도 있습니다.

소스 파일 검토

설치 여부를 결정하기 전에 SKILL.md와 SkillsMP에 표시된 보조 파일을 읽어 보세요.

SKILL.md 표시 중

SKILL.md
소스 지침 · 읽기 전용 미리보기
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`
GitHub에서 보기