creating-documentation

name	creating-documentation
description	Create and review README files and repository documentation that follows best practices for clarity, accessibility, and discoverability. Use when a user asks to create a README, write project documentation, improve existing documentation, add a CONTRIBUTING guide, review documentation for accessibility, or document a new repository.
license	MIT
allowed-tools	Bash

Creating Documentation

Overview

This skill provides capabilities for creating and reviewing README files and other repository documentation that follows established best practices for structure, accessibility, and user experience.

Good documentation is the front door to your project. It helps users understand what your project does, how to use it, and how to contribute. This skill ensures documentation is clear, accessible, and follows industry standards.

Capabilities

Capability	Action	Description
Create README	actions/create-readme.md	Generate a comprehensive README for a repository
Create CONTRIBUTING	actions/create-contributing.md	Generate contribution guidelines
Review	actions/review-documentation.md	Analyse existing documentation for quality and accessibility