home / skills / shaul1991 / shaul-agents-plugin / docs-guide

docs-guide skill

safe

This skill helps you generate user guides, tutorials, and quickstarts with clear structure and actionable instructions for docs.

npx playbooks add skill shaul1991/shaul-agents-plugin --skill docs-guide

Review the files below or copy the command above to add this skill to your agents.

Files (1)

SKILL.md

417 B

---
name: docs-guide
description: Docs Guide Agent. 튜토리얼, 사용 가이드 작성을 담당합니다.
allowed-tools: Read, Write, Edit, Grep, Glob
---

# Docs Guide Agent

## 역할
사용자 가이드 및 튜토리얼 작성을 담당합니다.

## 담당 업무
- 튜토리얼 작성
- 사용 가이드
- 퀵스타트
- FAQ

## 산출물 위치
- 튜토리얼: `docs/tutorials/`
- 가이드: `docs/guides/`

Overview

This skill is a Docs Guide Agent focused on producing clear tutorials, user guides, quickstart instructions, and FAQs. It organizes output into a consistent docs structure so content is ready to publish. It streamlines authoring for technical and product documentation tasks.

How this skill works

The agent analyzes product features, workflows, and user goals to generate step-by-step tutorials and concise guides. It outputs files and content organized for docs/tutorials/ and docs/guides/, with optional quickstart snippets and FAQ entries. It can adapt tone and depth for beginners or advanced users based on prompts.

When to use it

When creating a new product tutorial or onboarding flow
To produce quickstart guides for new releases or features
When standardizing user-facing documentation across teams
To draft FAQs from common support questions
When converting feature specs into step-by-step guides

Best practices

Provide clear target audience and skill level in the prompt
Include product screenshots, commands, or code snippets for reproducibility
Request a short quickstart and a longer tutorial for different user needs
Specify file structure and naming conventions for docs output
Review generated steps for accuracy against the current product state

Example use cases

Create a beginner-friendly quickstart that covers installation and first run
Write a multi-step tutorial demonstrating a common workflow with commands and expected outputs
Produce a structured user guide covering configuration, troubleshooting, and best practices
Generate an FAQ from product support logs to reduce repetitive tickets
Convert internal feature notes into public-facing docs following the repo structure

FAQ

What types of docs will the agent produce?

It produces tutorials, user guides, quickstart instructions, and FAQ entries organized for publishing.

How should I prepare input for best results?

Provide a clear audience, feature list, example commands or screenshots, and the preferred output structure and tone.

Where will files be placed?

Content is organized to be saved under docs/tutorials/ for tutorials and docs/guides/ for user guides.