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
- آخر نشاط في المصدر
- ١٥ سبتمبر ٢٠٢٦ في ٠٦:٥٠
- لغة SKILL.md المكتشفة
- الإنجليزية
- النجوم
- ٨١
- التفرعات
- ٢٣٩
خيارات التثبيت
يُحدَّد 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