writing-docs

Create and update Sloppy documentation with YAML frontmatter and three-section structure.

26|1|Updated Feb 25, 2026
One-click install
npx skills add https://github.com/TeamSloppy/Sloppy --skill writing-docs-teamsloppy
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: writing-docs
Source: https://github.com/TeamSloppy/Sloppy/tree/main/.cursor/skills/writing-docs
Command: npx skills add https://github.com/TeamSloppy/Sloppy --skill writing-docs-teamsloppy

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation often lags behind product updates, making it hard for users to find accurate setup and usage guidance. This skill provides a structured workflow to write and edit docs consistently across the Sloppy docs/ directory.

Core Features & Use Cases

  • Structured frontmatter-driven articles with a standardized layout and tone
  • Guidance for cross-linking, sidebars, and content organization in VitePress
  • Suitable for creating new docs pages, updating guides, or refining existing documentation for end users

Quick Start

Create or update a documentation article by following the frontmatter and section template in this skill's guidelines.

Frequently Asked Questions about writing-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I structure markdown documentation with YAML frontmatter in VitePress?

Markdown documentation in VitePress requires YAML frontmatter with layout and title properties. This skill enforces a three-section structure for each page to ensure consistent formatting and clear content organization across the docs directory.

What is the best way to update a VitePress sidebar when adding new documentation pages?

Updating a VitePress sidebar requires adding cross-linking entries for new documentation pages. This skill provides structured guidance to map new articles into the sidebar configuration, ensuring accurate navigation and content discoverability.

How do I write a consistent style guide for user documentation?

Writing a consistent style guide for user documentation involves applying a standardized layout and tone across all articles. This skill provides a guide-driven workflow to streamline authoring and maintain uniform structure for setup and usage guidance.

Do I need prior knowledge of VitePress to create structured documentation pages?

Creating structured documentation pages requires familiarity with markdown and VitePress configurations like sidebars and frontmatter. This skill guides you through the required YAML frontmatter fields and cross-linking rules without needing advanced framework expertise.

Why does my documentation structure feel inconsistent across multiple guides?

Inconsistent documentation structure often stems from missing standardized frontmatter and section templates. This skill solves that by enforcing a three-section structure with required YAML frontmatter layout and title fields for every article.