trail-sense-user-guides
Twórz i aktualizuj dokumentację użytkownika dla narzędzi Trail Sense
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Umiejętność do pisania i modyfikowania przewodników użytkownika dla aplikacji Trail Sense. Obsługuje tworzenie, edycję i aktualizację dokumentacji narzędzi, w tym strukturę przewodnika, konwencje formatowania i typowe sekcje. Idealny dla zespołów rozwijających narzędzia terenowe, którzy potrzebują spójnej, dobrze zorganizowanej dokumentacji dla użytkowników.
Jak używać
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.
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.
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.
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.
Zapisz dokument w lokalizacji
guides/en-US/guide_tool_[nazwa_narzędzia].txt, gdzie nazwa narzędzia odpowiada nazwie katalogu narzędzia w projekcie.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.