Skip to content

atoms-studio/nuxt-swiftsearch / .agents/skills/create-docs

create-docs

Verified

Create complete documentation sites for projects. Use when asked to: "create docs", "add documentation", "setup docs site", "generate docs", "document my project", "write docs", "initialize documentation", "add a docs folder", "create a docs website". Generates Docus-based sites with search, dark mode, MCP server, and llms.txt integration.

FileKindSize
SKILL.mdskill md12.1 KB
references/mdc-components.mdmarkdown5.4 KB
references/templates.mdmarkdown6.0 KB
references/writing-guide.mdmarkdown2.9 KB

references/writing-guide.md

View on GitHub
# Writing Guide

Guidelines for writing effective documentation content.

## Table of Contents

- [Action-Based Content](#action-based-content)
- [Page Titles](#page-titles)
- [Voice and Tone](#voice-and-tone)
- [Code Examples](#code-examples)

---

## Action-Based Content

Use action verbs in **H2/H3 headings** to make pages scannable and task-oriented.

| Static heading     | Action-based heading     |
| ------------------ | ------------------------ |
| Configuration      | Configure your app       |
| Database setup     | Connect a database       |
| Route protection   | Protect your routes      |
| Session management | Handle user sessions     |
| Error handling     | Handle errors gracefully |
| Deployment         | Deploy your application  |

### Action Verbs to Use

**Primary:** Add, Configure, Create, Set up, Enable, Connect, Handle, Customize, Deploy, Use

**Secondary:** Build, Implement, Integrate, Install, Define, Write, Run, Test, Debug, Update

---

## Page Titles

Different sections use different title styles:

| Section         | Style                    | Examples                                  |
| --------------- | ------------------------ | ----------------------------------------- |
| Getting Started | Nouns                    | Introduction, Installation, Quick Start   |
| Guide           | Topics                   | Authentication, Configuration, Deployment |
| API             | Function/Component names | useSession, fetchData, Button             |
| Recipes         | Action phrases           | Add Dark Mode, Deploy to Vercel           |

The action style lives in the **content headings**, not the page titles or file names.

---

## Voice and Tone

### Do

- Use **active voice** and **present tense**
- Write in **second person** ("you can", "your project")
- Be **direct** and **actionable**
- Start sentences with **action verbs** when possible

### Examples

| Passive/Wordy                      | Active/Direct                 |
| ---------------------------------- | ----------------------------- |
| The configuration can be set by... | Configure your app by...      |
| It is recommended that you...      | We recommend...               |
| The file should be created in...   | Create the file in...         |
| Authentication is handled by...    | Handle authentication with... |

---

## Code Examples

### File Path Labels

Always add file path labels to code blocks:

```ts [nuxt.config.ts]
export default defineNuxtConfig({
  // ...
});
```

### Multi-Package Manager Examples

Use `::code-group` and show the **detected package manager first**:

````markdown
::code-group

```bash [pnpm]
pnpm add package-name
```
````

```bash [npm]
npm install package-name
```

```bash [yarn]
yarn add package-name
```

```bash [bun]
bun add package-name
```

::

```

### Best Practices

- Include **working, copy-pasteable** examples
- Show **complete** code, not fragments
- Add **comments** for complex logic
- Use **realistic** variable names
```
rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization.Stars: 471kUpdated Claude CodeCodexVerifiedInstall
academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file).Stars: 198kUpdated Claude CodeCodexUnverifiedInstall
doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.Stars: 198kUpdated Claude CodeCodexVerifiedInstall