agentleFS
Sign inStart free
quochuydevquochuydev/kit/skills/write-user-guide/SKILL.md

write-user-guide

Skill0 starsChanged 8 months agoMITView on GitHub

Use when the user wants to create a user guide, walkthrough, or step-by-step instructions for how to use features on a web app. Triggers on requests to write user guides, feature tutorials, or onboarding docs.

1 other project uses a version of this.

Adopted by

Most recently taken up by

  • Other versions1 project uses a version of this.

    Word for word · 0

    None found.

    Edited · 0

    None found.

    Wrote their own version · 1

    1. tcdw/skills★ 2same name

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • In this repository8 other files it gives its agents.

The file

We split this skill into the rules it gives an agent

6 rules. About 0 are common, 6 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈6

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Before writing, ASK the user to fill in or confirm a feature table:

    line 13
  2. Distinctive:

    Use these verbs consistently:

    line 56
  3. Distinctive:

    Always ask for the step table FIRST — never assume the app's UI

    line 70
  4. Distinctive:

    Keep each step to ONE action

    line 71
  5. Distinctive:

    Use backticks for URLs

    line 74
  6. Distinctive:

    Write in plain language — the audience is end users, not developers

    line 75

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Write User Guide

Generate step-by-step user guides for web app features.

Process

Before writing, ASK the user to fill in or confirm a feature table:

StepActionPage
1Go to {url}{Page name}
2Click "{Button/Link}"{Page name}
3Fill in "{Field}" with {value}{Page name}
.........

Present this table as a template and ask the user to provide the steps. Do NOT guess the steps — the user knows their app.

Output Format

Once the user confirms the steps, generate the guide as a markdown file with this structure:

# {Feature Name}

## Overview
{One sentence describing what this feature does and who it's for.}

## Steps

### Step 1: {Action summary}
**Page:** {Page name}

{Action description}. Go to `{url}`.

### Step 2: {Action summary}
**Page:** {Page name}

Click **"{Button/Link}"**.

### Step 3: {Action summary}
**Page:** {Page name}

Fill in the **"{Field}"** field with your {value}.

...

Action Types

Use these verbs consistently:

VerbWhen to use
Go toNavigate to a URL or page
ClickPress a button, link, or menu item
Fill inEnter text into an input field
SelectChoose from a dropdown or radio buttons
ToggleTurn a switch on or off
UploadAttach a file
ConfirmAccept a dialog or review a summary

Rules

  • Always ask for the step table FIRST — never assume the app's UI
  • Keep each step to ONE action
  • Bold all UI element names (buttons, fields, links)
  • Include the page name for every step
  • Use backticks for URLs
  • Write in plain language — the audience is end users, not developers
  • Save output to docs/user-guides/{feature-name}.md

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free