Szablon instrukcji

Szablon instrukcji to gotowy wzorzec dokumentu opisującego kolejne kroki procedury.

Anatomia dobrze zbudowanego wzorca procedury

Użyteczny szablon instrukcji zaczyna się od metryki: tytuł, numer wersji, data obowiązywania, właściciel dokumentu i rejestr zmian. Dalej idzie cel, zakres stosowania, wymagania wstępne, czyli uprawnienia, narzędzia i dostępy potrzebne do wykonania zadania, a dopiero po nich numerowana lista kroków. Kroki formułuje się w trybie rozkazującym i jeden punkt to jedna czynność: otwarcie panelu i wybranie z niego pozycji to dwa osobne punkty, nie jeden. Zamyka całość sekcja weryfikacji, która odpowiada na pytanie, po czym poznać, że procedura się powiodła, oraz co zrobić, jeśli wynik jest inny od oczekiwanego.

Pliki wzorców, style i miejsce ich przechowywania

W Wordzie szablon zapisuje się w formacie DOTX, a przy dokumentach z makrami DOTM. Różnica jest praktyczna: podwójne kliknięcie takiego pliku tworzy nowy dokument na jego podstawie, zamiast otwierać sam wzorzec do edycji. Szablony użytkownika leżą domyślnie w katalogu profilu, w AppData\Roaming\Microsoft\Templates, a ścieżkę do szablonów firmowych wskazuje się w opcjach zapisywania. O trwałości szablonu decydują style, a nie ręczne formatowanie: nagłówki oparte na stylach od pierwszego do trzeciego poziomu pozwalają wygenerować spis treści z karty Odwołania i automatycznie ponumerować rozdziały. Dokument sformatowany na oko rozjedzie się przy pierwszej większej zmianie treści.

Co psuje szablon po kilku miesiącach używania

Najczęstsza wpadka to wklejanie fragmentów z innych dokumentów razem z ich formatowaniem — po kilkunastu takich operacjach lista stylów puchnie do kilkudziesięciu pozycji o nazwach będących wariacjami tego samego nagłówka. Druga: zrzuty ekranu wstawiane jako bitmapy w pełnej rozdzielczości, przez co plik instrukcji rośnie do kilkudziesięciu megabajtów i przestaje przechodzić przez limity załączników w poczcie. Trzecia: brak numeru wersji, przez co po firmie krąży kilka wariantów tej samej procedury i nikt nie potrafi wskazać obowiązującego. Osobna pułapka to pole daty wstawione jako automatyczne — aktualizuje się przy każdym otwarciu, więc dokument mający świadczyć o dacie wydania zawsze pokazuje dzień dzisiejszy.

Dokumentacja zostawiana po wdrożeniu systemu

Przy wdrożeniach oprogramowania handlowego opartego o SQL Server — Subiekt, WAPRO, Comarch — spisujemy klientowi procedury, o których nikt nie pamięta w chwili awarii: jak wykonać kopię bazy, jak odtworzyć ją na zapasowym stanowisku, jakim kontem logować się do serwera i gdzie leżą pliki licencji. Taki komplet bywa cenniejszy od samej naprawy, bo skraca przestój przy kolejnym incydencie z godzin do kilkunastu minut. Obsługujemy zarówno firmy, jak i klientów indywidualnych, a na czas dłuższych prac potrafimy podstawić laptopa zastępczego.