Jak tworzymy instrukcje
Wersja aplikacji sprawdzona w panelu: jeszcze niepotwierdzona · Zakres: Zasady redakcyjne podręcznika
Jedna procedura - jeden wynik
Dział zatytułowany „Jedna procedura - jeden wynik”Tytuł opisuje czynność użytkownika. Artykuł podaje cel, potrzebne uprawnienia, przygotowanie, numerowane kroki, spodziewany wynik i sposób poradzenia sobie z typowymi problemami. Podział na działy pomaga odnaleźć funkcję z menu, ale opis nie jest katalogiem przycisków.
Zrzuty ekranu
Dział zatytułowany „Zrzuty ekranu”Używamy prawdziwych ekranów aplikacji z danymi demonstracyjnymi. Podpis wskazuje czynność, a opis alternatywny wyjaśnia obraz osobie korzystającej z czytnika ekranu. Oznaczenia numerujemy zgodnie z krokami. Obraz uzupełnia instrukcję; istotne informacje pozostają również w tekście.
Zrzut otrzymuje wersję aplikacji i datę wykonania. Pliki umieszczamy w
public/screenshots/<procedura>/<wersja>/. Dane i obrazy przeznaczone dla konkretnego klubu
nie trafiają do publicznego podręcznika. Brak zrzutu oznaczamy wprost.
Źródło i publikacja
Dział zatytułowany „Źródło i publikacja”Pisząc artykuł, edytujemy plik .md. Nagłówek zawiera tytuł, odbiorcę, datę, stan weryfikacji,
potwierdzoną wersję aplikacji i zakres instancji. Generator tworzy HTML oraz indeks wyszukiwania.
Wynikowego HTML nie poprawiamy ręcznie.
Przed publikacją sprawdzamy treść, odnośniki, wyszukiwanie i układ na telefonie. Procedurę potwierdzamy w panelu testowym. Wysyłka rzeczywistych wiadomości wymaga osobnego zakresu wykonania.
Zgłoszenia uwag
Dział zatytułowany „Zgłoszenia uwag”Docelowo artykuł będzie miał odnośnik „Zgłoś nieaktualny krok” z identyfikatorem procedury. Na obecnym etapie nie zbieramy ocen ani komentarzy. Najpierw potrzebujemy użytecznej treści i procesu poprawiania zgłoszeń; obsługę opinii można potem podłączyć do istniejącego kanału wsparcia.