markdown-documentation

A well-structured README in Markdown typically includes a project title, description, installation instructions, usage examples, and links to documentation. This Skill provides conventions for organizing these sections consistently, ensuring clarity for new contributors and users discovering your project.

Markdown best practices for technical documentation include using active voice, properly formatted inline code and code blocks, clear heading hierarchy, admonitions for warnings or notes, and consistent formatting across documents. This Skill guides you through these conventions to create professional, readable docs.

API references in Markdown benefit from structured formatting with consistent parameter tables, code examples, and cross-document linking. This Skill teaches you how to organize endpoints, methods, and responses using Markdown conventions that remain scannable and maintainable.

Yes, Markdown works well for changelogs and CONTRIBUTING files. This Skill covers documentation patterns that apply across project docs—READMEs, guides, API references, changelogs, and contribution guidelines—so you maintain consistent structure and formatting throughout your project.

Cross-document linking in Markdown uses relative paths and anchor links to connect related docs. This Skill covers linking and formatting conventions that help users navigate between your README, API docs, guides, and other files without breaking references.

Consistent Markdown conventions make documentation easier to read, maintain, and scale across your project. This Skill ensures structure, formatting, and organization remain uniform whether you have one README or dozens of guides, reducing cognitive load for contributors and users.