Back to tags
Tag

Agent Skills with tag: readme

26 skills match this tag. Use tags to discover related Agent Skills and explore similar workflows.

repo-docs

Generate comprehensive repository documentation following team standards. Use when creating README, CLAUDE.md, ARCHITECTURE.md, DESIGN_DECISIONS.md, or any project documentation. Includes Mermaid diagrams, status indicators, and AI context files.

repository-managementdocumentation-generationmermaidproject-documentation
Optima-Financial
Optima-Financial
0

readme-updater

Keep README files current with project changes. Use when project structure changes, features added, or setup instructions modified. Suggests README updates based on code changes. Triggers on significant project changes, new features, dependency changes.

readmedocumentationproject-structuredependency-management
ovachiever
ovachiever
81

readme-generator

Generate and improve README files for software projects. Triggers on: 'create readme', 'generate readme', 'write readme', 'improve readme', 'update readme', 'fix readme', 'readme for this project'. Supports Rust (libraries, CLI tools, services), TypeScript/JavaScript (npm packages), and Python (PyPI packages). Applies ecosystem-specific conventions: badges, installation sections, MSRV for Rust, feature flags documentation.

readmedocumentation-generationecosystem-conventionsrust
bug-ops
bug-ops
1

docs-sync

Keep documentation in sync with code changes across README, docs sites, API docs, runbooks, and configuration. Use when the user asks to update docs, ensure docs match behavior, or prepare docs for a release/PR.

documentation-automationreadmerunbookversion-control
Nymbo
Nymbo
1

documentation-writer

Activates when user needs help writing documentation, README files, API docs, or code comments. Triggers on "write documentation", "create README", "document this API", "add JSDoc", "explain this code", "write docstrings", or documentation-related requests.

documentationreadmeapi-documentationdocstrings
always-further
always-further
1

readme-generator

Auto-generates professional README.md files for Arduino/ESP32/RP2040 projects following open-source best practices. Use when user wants to document their project for GitHub, needs help writing a README, or says "make my project shareable". Follows awesome-readme standards with sections for Overview, Hardware, Software, Setup, Usage, Troubleshooting, and Contributing.

documentation-automationcode-documentationopen-sourcereadme
wedsamuel1230
wedsamuel1230
1

documentation-standards

Apply documentation standards: comment why not what, minimal comments (prefer clear code), maintain README with quick start, update docs with breaking changes. Use when writing comments, creating docs, reviewing documentation, or discussing what to document.

documentationcommentsbest-practicesreadme
phrazzld
phrazzld
21

doc-organizer

Apply Progressive Disclosure principles to organize large documentation projects. Restructure docs into hierarchical structure, reduce token usage by 95%+, and create README files for navigation.

progressive-disclosurehierarchical-structuretoken-optimizationreadme
Tempuss
Tempuss
3

technical-writer

Generate technical documentation including READMEs, specifications, architecture documents, and runbooks. Use when creating or updating any technical documentation.

technical-writingreadmespecification-documentsarchitecture-documents
MykalMachon
MykalMachon
31

tech-doc-writer

This skill should be used when writing or reviewing technical documentation such as READMEs, API documentation, quickstart guides, or any user-facing documentation. Apply editorial principles focused on leading with value, cutting redundancy, and creating scannable, actionable content. Use when the user requests help writing docs, improving existing documentation, or creating user guides.

documentationtechnical-writinguser-guidereadme
kevinslin
kevinslin
3

documentation

Creates and maintains technical documentation including API docs, README files, architecture docs, and inline code comments. Trigger keywords: document, docs, readme, api docs, jsdoc, docstring, architecture doc.

readmejsdocdocstringspecification-documents
cosmix
cosmix
3

pypi-readme-creator

When creating a README for a Python package. When preparing a package for PyPI publication. When README renders incorrectly on PyPI. When choosing between README.md and README.rst. When running twine check and seeing rendering errors. When configuring readme field in pyproject.toml.

pythonpypireadmepyproject.toml
Jamie-BitFlight
Jamie-BitFlight
111

readme-generator

This skill creates or updates a README.md file in the GitHub home directory of the current project. The README.md file it generates will conform to GitHub best practices, including badges, project overview, site metrics, getting started instructions, and comprehensive documentation.

readmeGitHub-Flavored-Markdowndocumentation-websiterepository-structure
dmccreary
dmccreary
111

absurdist-readme-writer

Toolkit for creating an entertainingly stupid README that manages to give off Tim & Eric, Steve Brule vibes while maintaining a level of technical acumen that is expected of a modern open source project. This skill applies when users request a silly or absurd README.

readmemarkdowncreative-writinghumorous-content
delorenj
delorenj
4

skill-doc-generator

Auto-generates standardized README documentation from SKILL.md files, validates consistency (frontmatter, descriptions, terminology), and creates usage examples. Use when documenting individual skills, generating docs for multiple skills in a directory, or validating skill quality standards.

readmeschema-validationautomationcode-examples
Exploration-labs
Exploration-labs
72

validating-setup-commands

Use before creating worktrees or executing tasks - validates that CLAUDE.md defines required setup commands (install, optional postinstall) and provides clear error messages with examples if missing

clireadmedocumentation-validationerror-handling
arittr
arittr
6

cli-demo-gif

Generate CLI demo GIFs using vhs (Charmbracelet). Use when creating terminal recordings for README files or documentation.

terminalcligifdocumentation
b-open-io
b-open-io
62

claude-docs-updater

Update CLAUDE.md documentation files after code changes. Use when user says "update the CLAUDE.md", "sync the docs with my changes", "document what I changed", "update documentation for this package", or after making significant code modifications that should be reflected in project documentation.

markdownreadmetracked-changes
Uniswap
Uniswap
82

Page 1 of 2 · 26 results