Toolverse
All skills

trail-sense-user-guides

by kylecorry31

Write or update user guide documentation for Trail-Sense tools. Use when asked to create, write, update, or modify a tool's user guide, help documentation, or user-facing documentation. Covers guide structure, formatting conventions, and common sections.

Installation

Pick a client and clone the repository into its skills directory.

Installation

Quick info

Category
Frontend

About this skill

Write or update user guide documentation for Trail-Sense tools. Use when asked to create, write, update, or modify a tool's user guide, help documentation, or user-facing documentation. Covers guide structure, formatting conventions, and common sections.

How to use

  1. Użyj tej umiejętności, gdy chcesz stworzyć nowy przewodnik użytkownika lub zaktualizować istniejącą dokumentację dla narzędzia Trail Sense. Określ nazwę narzędzia, które dokumentujesz.

  2. Postępuj zgodnie ze standardową strukturą przewodnika: zacznij od krótkiego opisu celu narzędzia, następnie dodaj sekcje opisujące główne funkcje i sposób ich użycia. Każda sekcja powinna być jasna i skoncentrowana na jednym aspekcie narzędzia.

  3. Dla instrukcji krok po kroku używaj numerowanych list. Każdy krok powinien być konkretny i zawierać odniesienia do elementów interfejsu użytkownika, takich jak przyciski czy menu. Nazwy przycisków i pól powinny być pogrubione.

  4. Dodaj sekcje dla opcjonalnych pól, widgetów i szybkich akcji, jeśli są dostępne w narzędziu. Każde pole opisz w formacie: nazwa pola i jego przeznaczenie.

  5. Zapisz dokument w lokalizacji guides/en-US/guide_tool_[nazwa_narzędzia].txt, gdzie nazwa narzędzia odpowiada nazwie katalogu narzędzia w projekcie.

  6. Przejrzyj dokument pod kątem spójności formatowania: używaj nagłówków ## dla głównych sekcji, ### dla podsekcji, drugiej osoby ("Możesz...", "Aby utworzyć...") i czasu teraźniejszego.

Related skills