Patterns and structure for writing functional documentation including guides, conceptual explanations, tutorials, and best practices documentation.
Generates functional documentation with value-driven patterns, action-oriented headings, and structured guides.
/plugin marketplace add lerianstudio/ring/plugin install ring-tw-team@ringThis skill inherits all available tools. When active, it can use any tool Claude has access to.
Functional documentation explains concepts, guides users through workflows, and helps them understand "why" and "how" things work. This differs from API reference, which documents "what" each endpoint does.
| Type | Purpose | Key Sections |
|---|---|---|
| Conceptual | Explains core concepts and how things work | Definition → Key characteristics → How it works → Related concepts |
| Getting Started | First task with the product | Intro → Prerequisites → Numbered steps → Next steps |
| How-To | Task-focused for specific goals | Context → Before you begin → Steps → Verification → Troubleshooting |
| Best Practices | Optimal usage patterns | Intro → Practice sections (Mistake/Best practice) → Summary |
Start every document with what the reader will learn or accomplish.
✅ This guide shows you how to create your first transaction in under 5 minutes.
❌ In this document, we will discuss the various aspects of transaction creation.
Address the reader directly.
✅ You can create as many accounts as your structure demands.
❌ Users can create as many accounts as their structure demands.
Use for current behavior.
✅ Midaz uses a microservices architecture.
❌ Midaz will use a microservices architecture.
Indicate what the section covers or what users will do.
✅ Creating your first account
❌ Account creation process overview
2-3 sentences maximum. Use bullets for lists.
| Element | Usage |
|---|---|
| Info box | > **Tip:** Helpful additional context |
| Warning box | > **Warning:** Important caution |
| Code examples | Always include working examples for technical concepts |
| Tables | For comparing options or structured data |
Use --- to separate major sections. Improves scannability.
This skill should be used when the user asks about libraries, frameworks, API references, or needs code examples. Activates for setup questions, code generation involving libraries, or mentions of specific frameworks like React, Vue, Next.js, Prisma, Supabase, etc.
Applies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply.
Creating algorithmic art using p5.js with seeded randomness and interactive parameter exploration. Use this when users request creating art using code, generative art, algorithmic art, flow fields, or particle systems. Create original algorithmic art rather than copying existing artists' work to avoid copyright violations.