菜单
Use when the user asks to "write docs", "write documentation", "add a docs page", "create a tutorial", "document a feature", or any task involving writing or editing documentation pages, tutorials, how-to guides, concept pages, or reference pages for the project.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
| name | write-docs |
| description | Use when the user asks to "write docs", "write documentation", "add a docs page", "create a tutorial", "document a feature", or any task involving writing or editing documentation pages, tutorials, how-to guides, concept pages, or reference pages for the project. |
| argument-hint | [path/to/page.md or description of what to document] |
Write or edit documentation at $ARGUMENTS.
Before writing, read these files:
docs/contributing/writing-docs.md — page structure, Diataxis boundary
rules, cross-linking requirements, and templates for all four page types
(tutorial, how-to, concepts, reference). Follow the template for the
category you are writing.CLAUDE.md and docs/myst.yml — project conventions and TOC
structure.Respect the reader's time and intelligence. Write as a knowledgeable colleague explaining something at a whiteboard — not a legal contract, not a blog post.
Be direct. Use active voice. Address the reader as "you." Get to the point.
Be confident but honest. State things plainly. When something is a limitation or rough edge, say so.
Be warm without being chatty. A brief orienting sentence is welcoming. Excessive enthusiasm wastes the reader's time.
Be task-oriented. Structure around what the reader is trying to do, not what the software can do.
Be consistent in terminology. Pick a term and stick with it. If you call it a "workspace" in one paragraph, don't call it a "project" in the next.
Layer detail progressively. Lead with the most common case. Then explain options. Then cover edge cases. A reader who needs the quick answer gets it in 10 seconds; someone with a complex scenario keeps reading.
Be economical. Short sentences. Simple words. "Use" not "utilize." "Start" not "initialize" (unless "initialize" is the actual API term). Cut filler: "in order to," "it should be noted that," "as a matter of fact."
Be neutral about skill level. Never write "simply," "just," or "easily." Give clear instructions and let the reader judge difficulty.
.ipynb). Code cells should be runnable..md).artisan for framework, pipelines for domain).Before finishing, verify:
docs/myst.yml TOC if it's a new pageWrite or scaffold an Artisan composite operation. Use this skill when the user asks to create a composite, write a composite operation, scaffold a composite, compose operations, or any request involving CompositeDefinition subclasses. Trigger on phrases like "write a composite", "create a composite operation", "scaffold a composite", "compose operations", or any request to combine multiple operations into a reusable unit.
Write, scaffold, or review an Artisan pipeline operation. Use this skill when the user asks to create a new operation, write a creator or curator, scaffold an operation class, or review an existing operation for correctness. Trigger on phrases like "write an operation", "create a creator", "new curator", "scaffold operation", or any request involving OperationDefinition subclasses.
Write or scaffold an Artisan pipeline script. Use this skill when the user asks to create a pipeline, write a pipeline script, scaffold a pipeline, or build a data processing workflow. Trigger on phrases like "write a pipeline", "create a pipeline", "scaffold a pipeline", "build a pipeline script", "pipeline that does X", or any request to compose operations into a runnable pipeline.