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 语言: 英语
星标: 81
分支: 239

安装方式

默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。

用 AI 助手安装

复制这段 Prompt，发给你正在使用的 AI 助手。

Follow https://skillsmp.com/skill-install/prompt.md to install only the Agent Skill at https://github.com/apify/apify-docs/tree/master/.agents/skills/doc-write.

直接命令不会经过审查 Prompt；运行前请先检查来源。

npx skills add https://github.com/apify/apify-docs --skill doc-write

命令会保持在同一行。复制前请横向滚动并检查完整内容。

想先保存到本地？可下载 SkillsMP 当前能够提供的文件。

检查来源文件

决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。

文件资源管理器

3 个文件

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 查看

返回搜索返回安装

review-docs

Review Apify documentation for style guide compliance, quality standards, and best practices. Use when user says "review this doc", "check this page", "audit documentation", "review before PR", "is this ready to publish", or "review-docs". Runs automated checks and manual review against Apify style guide.

2026-09-15

tutorial

Create structured tutorials for Apify Academy or Platform documentation. Use when user says "create a tutorial", "write a tutorial", "build a step-by-step guide", "convert this guide into a tutorial", or "tutorial for [topic]". Handles tutorial structure, learning objectives, prerequisites, step-by-step instructions, code examples, and troubleshooting sections.

2026-09-15

api-doc

Create or update OpenAPI specifications and API documentation for Apify endpoints. Use when user says "add API endpoint", "create OpenAPI spec", "document this endpoint", "add code samples for API", "update API docs", or "api-doc". Handles OpenAPI YAML, schemas, code samples, and operation IDs.

2026-08-04

查看这个仓库的全部 Skills

doc-write

来源信息

安装方式

用 AI 助手安装

检查来源文件

同仓库更多 Skills

用 AI 助手安装

同仓库更多 Skills