Back to tags
Tag

Agent Skills with tag: readme

9 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-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

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
181

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
254

rails-technical-writer

Technical documentation specialist for Rails projects. Use when writing README files, API documentation, setup guides, architectural decisions, code comments, or user-facing documentation. Focuses on clarity, completeness, and maintainability.

railstechnical-writingapiuser-guide
alec-c4
alec-c4
385

md-docs

This skill should be used when the user asks to "update README", "update context files", "init context", "create CLAUDE.md", "update CLAUDE.md", "update AGENTS.md", "update DOCS.md", "generate documentation", "API documentation", or mentions project documentation, context files, or markdown documentation workflows.

documentationmarkdownreadmeAPI
PaulRBerg
PaulRBerg
7210