doc-write
Write or edit Apify documentation pages following the style guide. Use when user says "write docs for", "create a new page", "document this feature", "add documentation about", "edit this doc page", or "write a guide for [topic]". Handles platform docs, guides, and reference pages with proper formatting and structure.
소스 정보
- 저장소
- apify/apify-docs
- 최근 소스 활동
- 2026년 9월 15일 06:50
- 감지된 SKILL.md 언어
- 영어
- 스타
- 84
- 포크
- 244
설치 방법
기본적으로 소스를 먼저 확인하는 Prompt가 선택됩니다. 직접 명령으로 전환하거나 로컬 사본을 다운로드할 수도 있습니다.
소스 파일 검토
설치 여부를 결정하기 전에 SKILL.md와 SkillsMP에 표시된 보조 파일을 읽어 보세요.
파일 탐색기
3 개 파일SKILL.md 표시 중
SKILL.md
소스 지침 · 읽기 전용 미리보기- name
- doc-write
- description
- Write or edit Apify documentation pages following the style guide. Use when user says "write docs for", "create a new page", "document this feature", "add documentation about", "edit this doc page", or "write a guide for [topic]". Handles platform docs, guides, and reference pages with proper formatting and structure.
- allowed-tools
- Read Write Edit Bash Glob Grep
- argument-hint
- topic
# Documentation writing
## Process
1. **Determine doc type** - platform docs, guide, or reference (tutorials → use `/tutorial`)
2. **Research** - read related existing pages, check `standards/style-guide.md` for product names
3. **Create frontmatter** - title (sentence case), description (140-160 chars), sidebar_position, slug
4. **Write content** following the structure for the doc type:
- **Platform docs**: intro → prerequisites → main content → code examples → next steps
- **Guides**: intro with goal → step-by-step instructions → verification → troubleshooting
- **Reference**: brief description → parameters/options → examples → related pages
5. **Quality check** - run `pnpm lint:md` and `vale` before finishing
Key rules: US English, active voice, imperative tone, sentence case headings, bold for UI elements only, all admonitions need titles, code blocks need language tags.
For detailed structure templates, see `.agents/skills/doc-write/references/doc-structures.md`.
For edge cases and process notes, see `.agents/skills/doc-write/references/process.md`.
GitHub에서 보기