write

Orchestrate research, writing, and review for React documentation pages.

10|12|Updated Apr 29, 2023
One-click install
npx skills add https://github.com/reactjs/sw.react.dev --skill write-reactjs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: write
Source: https://github.com/reactjs/sw.react.dev/tree/main/.claude/skills/write
Command: npx skills add https://github.com/reactjs/sw.react.dev --skill write-reactjs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill streamlines the creation and updating of React documentation, ensuring consistency and accuracy across reference pages, learn guides, and blog posts.

Core Features & Use Cases

  • Automated Documentation Generation: Creates new reference, learn, or blog documentation based on user intent.
  • Content Updates: Modifies existing documentation pages with new information or corrections.
  • Research Orchestration: Gathers information from React's codebase, existing docs, and web searches to inform writing.
  • Use Case: A developer needs to document a new hook, useOptimistic. They can instruct the skill to "add optimisticKey reference docs," and it will research the hook, draft the documentation, and prepare it for review.

Quick Start

Use the write skill to add new reference documentation for the optimisticKey API.

Frequently Asked Questions about write

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

FAQPage Schema
How do I generate React documentation for a new API automatically?

To generate React documentation for a new API, you provide the API intent and the skill orchestrates parallel research from the codebase and web to synthesize a writing plan, producing ready-to-review reference content.

What is the best way to update existing React developer documentation?

Updating existing React developer documentation involves parsing your modification intent, researching the specific codebase changes, and synthesizing the new information into the current learn or reference pages for review.

Can I create both reference docs and blog posts for React using an automated writing process?

Yes, automated documentation writing supports creating both reference docs and blog posts by using specialized sub-skills to format the synthesized research into the appropriate content type for React.

Does generating React documentation require manual research of the codebase?

Generating React documentation does not require manual codebase research because the process orchestrates specialized agents to automatically gather information from the codebase, existing docs, and web searches.

How does the research process work when creating new React reference pages?

The research process for creating React reference pages works by deploying specialized agents in parallel to gather information from the React codebase, existing documentation, and web searches, which is then synthesized into a writing plan.

What formats of React documentation can be generated through content synthesis?

Content synthesis can generate three specific formats of React documentation: reference pages, learn guides, and blog posts, ensuring adherence to documentation standards through a structured review process.