Start writing a functional guide with voice, tone, and structure guidance
Generates functional documentation with proper voice, tone, and structure guidance.
/plugin marketplace add lerianstudio/ring/plugin install ring-tw-team@ring[topic]You're starting a functional documentation task. Follow these steps:
Topic to document: $ARGUMENTS.topic
First, gather context about this topic:
Select the appropriate structure:
For explaining what something is and how it works.
For helping users accomplish their first task.
For task-focused instructions with specific goals.
For guidance on optimal usage patterns.
--- dividers between major sectionsFor complex documentation, dispatch the functional-writer agent:
Task tool:
subagent_type: "functional-writer"
model: "opus"
prompt: "Write a [document type] for [topic]. Target audience: [audience].
The reader should be able to [goal] after reading."
After writing, use the docs-reviewer agent:
Task tool:
subagent_type: "docs-reviewer"
model: "opus"
prompt: "Review this documentation for voice, tone, structure, and completeness:
[paste documentation]"
Conceptual:
# Concept
Definition paragraph
## Key characteristics
## How it works
---
## Related concepts
Getting Started:
# Getting started with X
## Prerequisites
---
## Step 1
## Step 2
---
## Next steps
How-To:
# How to X
## Before you begin
## Steps
## Verification
Best Practices:
# Best practices for X
## Practice 1
- Mistake:
- Best practice:
## Summary
Topic to document: $ARGUMENTS.topic
This command MUST load the skill for complete workflow execution.
Use Skill tool: writing-functional-docs
The skill contains the complete workflow with: