agentleFS
avihaymenahemavihaymenahem/velo/.claude/skills/document-feature/SKILL.md

document-feature

Skill715 starsChanged 9 months agoApache-2.0View on GitHub

Add help documentation for a new or changed feature. Updates the Help page content, project docs (docs/, CLAUDE.md), and keeps counts accurate.

5 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

4 rules. 0 are common, 3 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 5 edited versions we read keep these.

  • 3

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Update project docs: if the feature affects them.

    line 68
  2. Distinctive:

    Write from the user's perspective: "Snooze a thread to temporarily hide it" not "Sets the SNOOZED label via Gmail API"

    line 76
  3. Distinctive:

    Keep descriptions to 2-3 sentences max

    line 77
  4. Very specific:

    Add a relatedSettingsTab link when the feature has configurable options

    line 79

“Common” is measured: kept by at least 6 in 10 of the 5 edited versions of this file we could read. “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

Document Feature

You just implemented or modified a feature. Now add or update its documentation across all relevant files.

What to do

  1. Read the current help content at src/constants/helpContent.ts to understand the existing structure.
  2. Determine where the feature belongs. The 13 existing categories are:
    • getting-started — First-time setup (accounts, sync, client ID)
    • reading-email — Thread view, reading pane, mark-as-read
    • composing — Compose, reply, undo send, schedule, signatures, templates, aliases, drafts
    • search-navigation — Search operators, command palette, keyboard shortcuts
    • organization — Labels, smart folders, filters, quick steps, star/pin/mute, archive/trash, multi-select, drag & drop
    • productivity — Snooze, follow-up reminders, split inbox, spam
    • ai-features — AI overview, summaries, smart replies, compose, Ask Inbox
    • newsletters — Newsletter bundles, unsubscribe
    • notifications-contacts — Notifications/VIP, contact sidebar
    • security — Phishing, auth badges, remote images, link confirmation
    • calendar — Google Calendar
    • appearance — Theme, accent colors, font/density, layout
    • accounts-system — Multi-account, system tray, global shortcut, pop-out windows
  3. Add a new HelpCard to the appropriate category's cards array, or update an existing card if the feature enhances something already documented. Each card needs:
    {
      id: "kebab-case-unique-id",        // unique across ALL categories
      icon: SomeLucideIcon,              // import from lucide-react
      title: "Short user-facing title",  // what users see
      summary: "One-line summary shown when collapsed (~40-60 chars).",
      description: "Detailed explanation shown when the card is expanded. 3-5 sentences covering what it does, how it works, and practical details. Write from the USER's perspective, not a developer's.",
      tips?: [                           // optional but recommended
        { text: "How to use it or a useful detail" },
        { text: "Keyboard shortcut", shortcut: "key" },
      ],
      relatedSettingsTab?: "general",    // optional, must be a valid tab ID
    }
  4. Valid relatedSettingsTab values: general, composing, labels, filters, smart-folders, quickSteps, contacts, accounts, sync, shortcuts, ai, subscriptions, developer
  5. If adding a contextual tip (for ? tooltips in the UI), add an entry to the CONTEXTUAL_TIPS record:
    "tip-id": {
      title: "Short title",
      body: "One sentence explaining the setting or feature.",
      helpTopic: "category-id",  // must match a category ID
    }
  6. Run the help content tests to validate your additions:
    npx vitest run src/constants/helpContent.test.ts
    The tests check: unique IDs, non-empty titles/descriptions, valid settings tab references, valid contextual tip topic references.
  7. Run type-check to make sure icon imports are correct:
    npx tsc --noEmit
  8. Update project docs if the feature affects them. Check each file and update as needed:
    • docs/architecture.md — Update if the feature adds new component groups, services, stores, database tables, or changes the project structure tree. Keep counts accurate (component groups, file counts, table counts).
    • docs/development.md — Update if test counts change or new development workflows are introduced.
    • docs/keyboard-shortcuts.md — Update if the feature adds or changes keyboard shortcuts.
    • CLAUDE.md — Update the relevant section (component organization, service layer, key gotchas, etc.) to reflect the new feature.

Writing guidelines

  • Write from the user's perspective: "Snooze a thread to temporarily hide it" not "Sets the SNOOZED label via Gmail API"
  • Keep descriptions to 2-3 sentences max
  • Include keyboard shortcuts in tips when the feature has them
  • Add a relatedSettingsTab link when the feature has configurable options
  • Pick an icon that visually represents the feature (browse lucide-react icons)

Feature description

$ARGUMENTS

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.