Procedura jest jak przepis - zestaw instrukcji jasno określających, kto coś robi, kiedy powinien być zrobiony, jak to się robi i jaki powinien być wynik. Lista każdego kroku w kolejności, w jakiej musi zostać ukończona. Kompilacja wielu procedur w instrukcji uporządkowanej według opisu stanowiska, działu, funkcji lub dowolnej kolejności sprawia, że informacje są najbardziej dostępne dla użytkowników podręcznika. Nie należy mylić zasad z procedurami. Zasady to reguły lub deklaracje stanowiska; Procedury są tym, co ludzie śledzą, aby realizować politykę.
Przedmioty, które będą potrzebne
-
Istniejąca dokumentacja, która może być materiałem źródłowym
-
Eksperci ds. Tematu, którzy wiedzą, jak wykonywać te procedury
Zdecyduj, które procedury należy udokumentować. Dwie metody wyboru zawartości podręcznika to badanie potencjalnych użytkowników ręcznych, aby dowiedzieć się, jakie zadania wymagają wyjaśnienia lub więcej informacji, lub możesz utworzyć listę problemów operacyjnych, które można rozwiązać za pomocą jasno zdefiniowanych procedur.
Zbierać informacje. Osoba już wykonująca to zadanie to najlepszy zasób, chyba że tworzysz procedury od początku. Obserwuj, jak dana osoba wykonuje zadanie i rób notatki lub poproś ją o zapisanie wszystkich kroków związanych z zadaniem, a także wskazówek i ostrzeżeń zdobytych dzięki doświadczeniu.
Ustal układ swojego podręcznika. Format dwukolumnowy sprawia, że procedury są przejrzyste i łatwe do odczytania. Nazwij każdą stronę nazwą procedury i umieść pod tytułem listę lub akapit wszelkich faktów, które nie mieszczą się w kroku, na przykład częstotliwość przeprowadzania procedury oraz wskazówki lub ostrzeżenia. Procedura powinna następować po tym w tabeli dwukolumnowej.
Napisz przybliżony projekt. W lewej kolumnie podaj osobę odpowiedzialną za procedurę. W prawej kolumnie, listę, aby wykonać czynności, które osoba wykonuje. Jeśli procedura obejmuje wiele osób, wszyscy powinni jasno zobaczyć, gdzie mieszczą się w procesie i co muszą zrobić.
Przetestuj procedury. Poproś kogoś, aby zapoznał się z procedurami, aby śledzić je w projekcie. Ważne jest, aby użyć kogoś niedoświadczonego, aby osoba nie przyjmowała żadnych zwykłych skrótów ani nie połyskiwała niejasnych punktów, których inny czytelnik nie zrozumiałby.
Popraw wersję roboczą. Wyjaśniaj, dodawaj, usuwaj i zmieniaj kolejność kroków, dopóki procedury nie mogą być przestrzegane przez osoby czytające instrukcję.
Opublikuj podręcznik. Dołącz spis treści, aby czytelnicy mogli szybko zlokalizować procedury. Dodaj glosariusz definiujący dowolną terminologię, która jest rzadka lub specyficzna dla Twojej branży.
Wskazówki
-
Nie używaj eleganckiej wariacji słów, aby ożywić pisanie. "Widżet" to widget za każdym razem, a nie "przedmiot" lub "urządzenie". Ciągłe opisywanie spraw może być powtarzalne, ale poprawia czytelność czytelników.
