ReddRadar
Agent skill
write-docs
Write AI-scannable technical documentation.
Install this agent skill to your Project
npx add-skill https://github.com/michalvavra/agents/tree/main/archive/skills/write-docs
SKILL.md
Write Documentation
Documentation that is scannable, consistent, and actionable for AI agents.
Structure
- Max 150 lines per file, one concept per file
- Start with
description:in YAML frontmatter - Add TL;DR section at top with most-needed info
Content
- No duplicates (define once, link elsewhere)
- Use tables for structured data (parameters, config)
- Concrete examples for everything (copy-pasteable)
- Link to real code as templates
Naming
| Pattern | Use For | Example |
|---|---|---|
README.md |
Directory overview | docs/README.md |
{noun}.md |
Reference | entities.md |
{verb}-{noun}.md |
How-to | add-entity.md |
Tips
- Use consistent terms (one term per concept)
- Group by task ("How to add X") not system ("X overview")
- Include troubleshooting for common errors
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
michalvavra/agents
brave-search
Web search via the Brave Search API. Use to retrieve search results from Brave when web lookups are needed.
michalvavra/agents
dogfood
Systematically explore and test a web application to find bugs, UX issues, and other problems. Use when asked to "dogfood", "QA", "exploratory test", "find issues", "bug hunt", "test this app/site/platform", or review the quality of a web application. Produces a structured report with full reproduction evidence -- step-by-step screenshots, repro videos, and detailed repro steps for every issue -- so findings can be handed directly to the responsible teams.
michalvavra/agents
snowcli
CLI for Snowflake. Query data, manage warehouses, databases, schemas, tables, and stages. Use when working with Snowflake data platform.
michalvavra/agents
qmd-knowledge
Knowledge management with QMD (Quick Markdown Search). Search, retrieve, and organize your personal knowledge base, notes, docs, and meeting transcripts. Use when asking about past notes, documentation, meetings, or when needing to recall information from your indexed markdown files.
michalvavra/agents
compare-tech
Compare technologies using a weighted scoring matrix. Use when evaluating libraries, frameworks, SaaS, or infrastructure options.
michalvavra/agents
asncli
CLI for Asana. Manage projects and tasks.
Didn't find tool you were looking for?