docs-guidance

Rewrite project documentation pages for clarity, structure, and safety.

6.4k|353|Updated May 3, 2019
One-click install
npx skills add https://github.com/petyosi/react-virtuoso --skill docs-guidance
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-guidance
Source: https://github.com/petyosi/react-virtuoso/tree/main/.codex/skills/docs-guidance
Command: npx skills add https://github.com/petyosi/react-virtuoso --skill docs-guidance

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Clarifies and improves project documentation to be readable, well-structured, and safe.

Core Features & Use Cases

  • Contract-first documentation: Start with user problems, then define concepts, data contracts, and lifecycle implications.
  • Safety and clarity focus: Emphasizes readability, concrete examples, and safety considerations across docs.
  • Editorial workflow guidance: Provides step-by-step workflow to rewrite pages, maintain consistency, and provide escape hatches for edge cases.

Quick Start

Rewrite a given page to improve clarity, flow, and safety, starting from the reader's task.

Frequently Asked Questions about docs-guidance

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

FAQPage Schema
How do I improve project documentation for readability and safety at scale?

To improve documentation readability and safety at scale, you can rewrite pages using a contract-first approach that starts with user problems, defines concepts before use, and ends with concrete next steps.

What is contract-first documentation and how does it structure technical guides?

Contract-first documentation structures technical guides by starting with user problems, defining concepts before use, showing data or API contracts before examples, and ending with a concrete next step.

How do I rewrite troubleshooting and installation guides to improve clarity?

You can rewrite troubleshooting and installation guides by applying an editorial workflow that starts from the reader's task, maintains consistency, and provides escape hatches for edge cases.

Does this approach work for migration guides and concept pages across an entire repository?

Yes, this approach works for migration guides, concept pages, example pages, and troubleshooting across a repository where documentation quality is treated as a product concern.

How do I structure API contracts and examples in documentation to ensure user safety?

To ensure safety in documentation, you structure pages by showing data or API contracts before examples, emphasizing concrete examples, lifecycle implications, and safety considerations throughout.