Procedury i szablony
Czym zajmują się technical writerzy? Tworzą m.in. procedury i szablony, w różnych postaciach. A czym zajmują się procedury i szablony? I czym właściwie są?
Procedury nie opisują produktu czy projektu, tylko proces, np. proces wykonywania pewnej czynności w naszej firmie. Szablony (ang. templates), np. szablon procedury 😊, służą ujednoliceniu wyglądu dokumentów danego typu. Innymi słowy, jeżeli chcecie by każdy projekt w którym bierzecie udział wymagał zaplanowania Waszej pracy, przeglądu tworzonej dokumentacji, a na końcu gratulacji dla techwritera 😉 i formalnego raportu z końcowego, to opiszcie to w procedurze. Jeżeli dodatkowo pragniecie by raporty z projektów wyglądały podobnie i zawsze zawierały istotne dla Was informacje - stwórzcie szablon raportu końcowego z projektu. Zrozumiałe?
Przykłady procedur:
- Procedura dezynfekcji rąk,
- Procedura przeprowadzania audytu,
- Procedura testowania oprogramowania,
- Procedura podróży służbowych,
- Procedura aktualizacji procedur...
Przykłady szablonów:
- Szablon specyfikacji wymagań,
- Szablon raportu z audytu,
- Szablon raportu z testów,
- Szablon rozliczenia podróży służbowej (często w formie pliku Excel),
- Szablon prezentacji,
- Szablon certyfikatu...
Adresatami tego typu dokumentów są najczęściej odbiorcy wewnętrzni - pracownicy firmy. Forma i zawartość różnią się w zależności od organizacji i preferowanych narzędzi. Procedura może mieć formę pliku Word, PDF, diagramu w Visio, strony Wiki, HTML, itp., itd. Szablon - w zależności od zastosowania - Word, PDF, Excel, itd.
Procedur z zasady nikt nie czyta 😉. Chyba, że są wydrukowane i dostaje je w formie papierowej nowy pracownik, dla którego dział IT nie zdążył jeszcze przygotować komputera. Dlaczego tak jest? Dobrze napisana procedura nie usypia, jest zwięzła i konkretna i przede wszystkim można się z niej czegoś nauczyć. Aby spełniała te warunki, powinna być napisana "z głową". A jak powstaje większość procedur? Szef działu spisuje ją byle jak i przynosi do techwritera z prośbą o poprawienie literówek i sformatowanie. Na wczoraj. Niestety z szablonami jest podobnie :(.
Następnym razem, zanim zaczniesz pracę nad procedurą, zapytaj szefa: kto jest odbiorcą i czego ma się z niej nauczyć. I spróbujcie razem napisać coś pożytecznego.