writing-user-facing-docs

What problem does it solve?

This Skill helps you avoid writing user-facing documentation that confuses readers or mixes the wrong kinds of content together, so users can find what they need and understand how to use your project.

Core Features & Use Cases

• Documentation planning with purpose: Uses the Divio documentation system to separate content into tutorials, how-to guides, reference guides, and explanations so each piece serves the right job.
• User-focused editing guidance: Directs you to focus on conventions and structure appropriate for human readers (e.g., README-style prose) rather than agent-facing or internal documentation.
• Markdown quality improvement: Applies a Markdown style guide and writing guidance to improve readability, consistency, and skimmability for developers.

Quick Start

Read the Divio documentation-system references and the Markdown style guide, then write or substantially revise your user-facing docs (like README files, tutorials, how-to guides, and reference prose) using the documented structure and conventions.