Loading...
Loading...
Found 16 Skills
Systematic documentation authoring workflow for AI coding agents. Analyzes repositories to determine what documentation is needed, classifies each document by Diataxis type (tutorial, how-to, reference, explanation), and generates accurate, maintainable documentation that stays synchronized with the codebase. Handles greenfield projects (no docs exist), brownfield updates (refresh, enhance, rewrite existing docs), and doc audits with workflow-specific guidance for each. Use when the user requests documentation for a project: README creation, API reference, architecture docs, developer guides, changelogs, or any technical writing tied to a codebase. Also use when existing docs need auditing, updating, rewriting, or restructuring. Triggers on phrases like "write a README", "document this project", "API reference", "architecture doc", "developer guide", "getting started guide", "tutorial", "how-to", "audit our docs", "what docs are missing", "refresh the docs", "Diataxis", "doc the public API", "write a CHANGELOG", "explain this codebase", "onboarding doc", or "ADR". Triggers when creating or editing `README.md`, `CONTRIBUTING.md`, `CHANGELOG.md`, `docs/`, `mkdocs.yml`, `docusaurus.config.*`, `sphinx`/`conf.py`, ADRs, or any markdown file paired with code. Triggers when public APIs, CLI flags, configuration options, or environment variables change and the user wants the docs kept in sync. Do NOT use for standalone prose, marketing copy, blog posts, design documents, RFCs unrelated to a codebase, or documents where the source of truth is not source code.
Guidance for structuring Ark documentation using the Diataxis framework. Use this skill when creating new docs, deciding where content belongs, reviewing documentation PRs, or restructuring existing documentation.
Applies the Diataxis framework to create or improve technical documentation. Use when being asked to write high quality tutorials, how-to guides, reference docs, or explanations, when reviewing documentation quality, or when deciding what type of documentation to create. Helps identify documentation types using the action/cognition and acquisition/application dimensions.
Writing clear, discoverable software documentation following the Eight Rules and Diataxis framework. Use when creating README files, API docs, tutorials, how-to guides, or any project documentation. Automatically enforces docs/ location, linking requirements, and runnable examples.
Writes and audits technical documentation using Diataxis, Stripe-style clarity, and the Eight Rules. 52 rules across 9 categories covering voice, structure, clarity, code examples, formatting, navigation, scanability, content hygiene, and review. Use when writing docs, creating READMEs, documenting APIs, writing tutorials, building a docs site, or auditing documentation quality.
Helps maintain documentation pages based on the Diataxis method. Analyzes existing docs, classifies pages into tutorials/how-to/explanation/reference categories, identifies gaps, and helps create or restructure documentation following Diataxis principles. Use when user mentions documentation structure, Diataxis, doc categories, tutorials vs how-to guides, or reorganizing docs.
Generate a README introduction following the Diataxis 4-paragraph structure for product documentation.
Write, review, and restructure useful documentation with Diataxis, audience-specific README patterns, and AI-writing trope cleanup. Use when creating docs, improving READMEs, reorganizing documentation, or editing prose for clarity.
Expert technical documentation specialist for developer docs, API references, and runbooks. Activate on: documentation, docs, README, API reference, technical writing, user guide, runbook, ADR, changelog, release notes, tutorial, how-to guide. NOT for: marketing copy (use copywriting skills), blog posts (use content skills), code comments (handled by developers).
Tutorial patterns for documentation - learning-oriented guides that teach through guided doing
Write a new doc-site page (guide, tutorial, reference, concept) following the project's docs conventions. Use when user says 'write a doc', 'add a page to the docs site', 'create a guide for X', 'write a tutorial', 'document this concept', or 'add reference for our API'. Do NOT use for feature-specific end-user docs (use document-feature), ADRs (use document-decision), or CLAUDE.md updates (use create-or-audit-claude-md).
Layered technical-writing standard: Diátaxis structure, Google developer style sentences, STE instruction rules, Global English syntax. Use for /technical-writing or when writing or reviewing docs, RFCs, readmes, PR descriptions, or commit messages.