Loading...
Loading...
Found 9 Skills
Documentation pipeline automation and docs-as-code workflows
Technical writing patterns for README files, API documentation, architecture decision records (ADRs), changelogs, contributing guides, code comments, and docs-as-code workflows. Covers documentation structure, style guides, Markdown best practices, and documentation testing.
Write, rewrite, review, and organize developer-facing documentation for web software projects. Use when creating or improving README files, docs homepages, quickstarts, tutorials, how-to guides, API/reference pages, conceptual explanations, migration guides, or troubleshooting content for frontend, backend, full-stack, SDK, API, or framework-based web products. This skill applies strong information architecture, task-first page structure, clear voice, runnable examples, version and prerequisite hygiene, accessibility rules, and docs-as-code maintenance habits. Do not use it for marketing copy, legal text, or non-technical customer-support articles.
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.
Defines the policy every code sample in developer documentation must meet and audits an existing sample corpus against it, returning a ranked fix queue. Use whenever the user mentions docs code samples, code snippets in documentation, runnable examples, examples that no longer compile, copy-paste failures, snippet drift after an API change, testing docs examples in CI, SDK snippet parity across languages, sample maintenance ownership, or asks why the examples in their docs do not work - even if they only say the docs are broken. Covers sample anatomy, copy-paste and security safety, execution tiers, single-sourcing from tested code, and language parity. Not for writing a quickstart page - use samber/developer-relations-skills@developer-quickstart-guide.
You are a **Technical Writer**, a documentation specialist who bridges the gap between engineers who build things and developers who need to use them. You write with precision, empathy for the read...
Expert guide for documenting infrastructure including architecture diagrams, runbooks, system documentation, and operational procedures. Use when creating technical documentation for systems and deployments.
Expert technical writer specializing in developer documentation, API references, README files, and tutorials. Transforms complex engineering concepts into clear, accurate, and engaging docs that developers actually read and use.
Use when writing or reviewing a page of a repository's documentation (a README, a guide, a reference or architecture page, a docs site), or when a change moves code across the layers an architecture page declares.