Skip to main content

draft-troubleshooting

Draft a new troubleshooting documentation page or update an existing one. Use for known issues, common errors, and diagnostic guides. Troubleshooting pages follow a problem → cause → solution format, leading with the symptom the user sees.

소스 정보

저장소
warpdotdev/docs
최근 소스 활동
2026년 10월 6일 05:43
감지된 SKILL.md 언어
영어
스타
44
포크
27

설치 방법

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

소스 파일 검토

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

SKILL.md 표시 중

SKILL.md
소스 지침 · 읽기 전용 미리보기
name
draft_troubleshooting
description
Draft a new troubleshooting documentation page or update an existing one. Use for known issues, common errors, and diagnostic guides. Troubleshooting pages follow a problem → cause → solution format, leading with the symptom the user sees.
# Draft troubleshooting page Draft a troubleshooting page that helps users diagnose and fix common issues. ## Workflow Follow the workflow in `.agents/skills/draft_docs/SKILL.md`, using the **troubleshooting template** at `.agents/templates/troubleshooting.md`. ## Frontmatter description One to two sentences, 50-160 characters, naming the symptoms covered rather than the act of troubleshooting. - ✅ `Fix sign-in failures, failed conversation resumes, and update problems in the Warp Agent CLI.` - ❌ `Troubleshooting information for common problems.` See "Descriptions by content type" under Frontmatter in `AGENTS.md` for the full rules. ## Content type rules These rules are specific to troubleshooting pages (from the "Drafting by content type" section of `AGENTS.md`): - Use the problem or error message as the header — this helps with search. - Group related issues under broader category headers (e.g., "SSH", "Shells"). - Lead with the symptom — the reader arrived because something broke. Don't make them read context before getting to the fix. - Provide workarounds when a fix isn't available. - Link to related troubleshooting pages and support channels. - Include workarounds even when no fix exists — documenting a known issue without a workaround still saves the user time searching. - Title convention: "Troubleshooting [feature]" or "Error: [error name]" - Apply the tone rules in AGENTS.md → Voice & tone: lead with the fix, not framing; no marketing buzzwords or meta-openers. Delete any category or symptom section you don't have real content for — 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. - ✅ `# Troubleshooting environments` - ✅ `## Agent fails to start` - ❌ `# Troubleshooting Environments` - ❌ `## Agent Fails To Start` ## Existing examples Read 2-3 of these strong examples to match the existing pattern: - `src/content/docs/support-and-community/troubleshooting-and-support/known-issues.mdx` - `src/content/docs/agents/cli/oz-cli/troubleshooting.mdx`
GitHub에서 보기