writing-documentation-for-llms
Description
Create effective documentation that LLMs can discover and use.
How to Use
- Visit the GitHub repository to get the SKILL.md file
- Copy the file to your project root or .cursor/rules directory
- Restart your AI assistant or editor to apply the new skill
Full Skill Documentation
name
Writing Documentation for LLMs
description
Create effective documentation that LLMs can discover and use. Use when documenting code, APIs, features, or creating reference materials. Covers structure, conciseness, examples, and anti-patterns for optimal LLM comprehension.
Tags
Related Skills
internal-comms
A set of resources to help write internal communications like status reports, leadership updates, newsletters, FAQs, and incident reports.
openapi-spec-generation
Generate and maintain OpenAPI 3.1 specifications from code, design-first specs, and validation patterns.
content-research-writer
Assists in writing high-quality content by conducting research, adding citations, improving hooks, and iterating on outlines.
docs-review
Review documentation changes for compliance with the Metabase writing style guide.
coding-tutor
Personalized coding tutorials that build on your existing knowledge and use your actual codebase for examples.