write-guide

Generates progressive how-to guides with front matter, steps, and conclusions from provided materials.

142k|31.7k|Updated Oct 5, 2016
One-click install
npx skills add https://github.com/vercel/next.js --skill write-guide
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: write-guide
Source: https://github.com/vercel/next.js/tree/main/.agents/skills/write-guide
Command: npx skills add https://github.com/vercel/next.js --skill write-guide

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Creating comprehensive, easy-to-follow guides from notes, docs, or specifications can be time-consuming and error-prone. This skill automates the process by turning inputs into a consistent, progressive learning narrative.

Core Features & Use Cases

  • Progressive guide generation with 2-4 steps.
  • Auto-includes frontmatter, introduction, and a conclusion.
  • Converts existing material into step-by-step tutorials for onboarding, product training, API usage, or feature documentation.

Quick Start

Ask to draft a progressive guide on a chosen topic using the provided materials.

Frequently Asked Questions about write-guide

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

FAQPage Schema
How do I generate step-by-step tutorials from existing documentation?

To generate step-by-step tutorials from documentation, provide your existing notes or specs to create a progressive learning narrative with 2-4 steps, an introduction, and a conclusion.

What is progressive guide writing for software onboarding?

Progressive guide writing for software onboarding structures documentation into a narrative with 2-4 sequential steps, concrete examples, and observable outcomes to train users effectively.

Can I convert API specifications into a Markdown tutorial with frontmatter?

Yes, you can convert API specifications into a Markdown tutorial that includes frontmatter with a name and description, a narrative body, and a next steps section.

Does the generated guide structure support design system documentation?

Yes, the generated guide structure supports design system documentation by applying a progressive learning narrative with concrete examples and observable outcomes across 2-4 steps.

Are there limitations to the number of steps in a generated tutorial?

Yes, a limitation of the generated tutorial is that it constrains the progressive learning narrative to a maximum of 2-4 steps to ensure focused and observable outcomes.