documentation-standards

Review README.md files for compliance with documentation standards.

2|Updated May 15, 2015

Search Tags:#changelog #documentation #markdown #technical writing #readme #standards #contributing

Ready to run

npx skills add https://github.com/stephendolan/dotfiles --skill documentation-standards-stephendolan

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-standards
Source: https://github.com/stephendolan/dotfiles/tree/main/claude/skills/documentation-standards
Command: npx skills add https://github.com/stephendolan/dotfiles --skill documentation-standards-stephendolan

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Inconsistent, unclear, or outdated project documentation wastes valuable time, creates confusion for developers, and hinders project adoption. This Skill automates the enforcement of documentation best practices, ensuring clarity and consistency across all your project files.

Core Features & Use Cases

Standardized File Structures: Provides essential sections and ordering for README.md, CONTRIBUTING.md, and CHANGELOG.md.
Markdown Formatting Guidelines: Enforces consistent headers, code blocks, lists, and links for scannable content.
Technical Writing Clarity: Guides you to use active voice, imperative mood, and concise sentences for effective communication.
Use Case: Ensure your new feature's documentation meets project standards, or quickly audit and improve an existing README.md for clarity and consistency.

Quick Start

Review my README.md file for compliance with documentation standards and suggest improvements.