• Articles
• admin

Kto jest podekscytowany, aby porozmawiać instrukcje obsługi?

Rozumiem. Ale jeśli jesteś taki jak ja, to zgadzasz się, że dokumentowanie procesów & systemów jest niezbędne dla każdej organizacji non-profit. To tylko kwestia znalezienia na to czasu.

a czemu nie? Dokumentacja pozwala zaoszczędzić czas na dłuższą metę. Oszczędza nam to niepotrzebnych spotkań & rozwiązywanie problemów, umożliwiając pracownikom znalezienie własnych odpowiedzi.

nie wspominając o tym, że to cholernie dobra umiejętność. I to jest kluczowe dla podtrzymania swojej pracy, jeśli &Twój sposób org.

spróbuj odłożyć na to czas. Poniższe kroki powinny pomóc zrobić to tak bezbolesne, jak to możliwe…a jeśli nie, jest „freebie” pod koniec będziesz chciał chwycić.

zacznij od zarysu.

przed wpisaniem procedur i definicji rozważ strukturę dokumentu. Jakie tematy będą łatwe dla pracowników? A jaka struktura będzie łatwa do aktualizacji w czasie?

Spoiler: to będzie Twój spis treści!

dla example…my podręcznik zespołu Salesforce jest podzielony głównie na obiekty. Ale w zależności od konfiguracji podział tematów według działu lub funkcji może mieć większy sens.

Zacznij szeroko. Potem wąsko.

Twoja instrukcja musi zawierać szczegółowe informacje i instrukcje krok po kroku. Zasadniczo, wszystkie rzeczy, o których zapominają nasi koledzy.

ale dobra dokumentacja Da również pomocny, z lotu ptaka widok na to, jak system jest zorganizowany & dlaczego. Miej to na uwadze podczas planowania konspektu w Kroku 1.

p. s.Gorąco polecam Możesz użyć darmowego narzędzia, takiego jak rysunki Google, lub zbudować coś w dokumencie Word lub Powerpoint (używając linii kształty &). To nie musi być eleganckie!

Zdefiniuj wszystkie swoje dane.

każdy zasób technologiczny w Twojej bazie danych jest manifestacją jakiejś prawdziwej „rzeczy”: czy jest to osoba (darczyńcy, wolontariusze itp.), transakcja (darowizna, dotacja itp..), lub partnerstwo (realizacja programu).

dobra dokumentacja wypełni lukę między rzeczywistością a techniczną, określając, co reprezentują pola obiektów & w rzeczywistym świecie.

Meta, wiem.

poinstruuj swoich użytkowników.

Twoja Instrukcja obsługi powinna zrobić dwie rzeczy: zdefiniować i poinstruować.

jeśli pracownicy muszą wykonywać zadania w Twojej bazie danych – wprowadzanie danych, aktualizowanie danych, a nawet wyszukiwanie – pomóż im, dołączając instrukcje krok po kroku dla tych rzeczy.

podpowiedź: listy numerowane & krótkie zdania są tutaj twoim przyjacielem.

napisz wszystko raz. Następnie przyciąć, wielokrotnie.

wszyscy znamy ból czytania podręcznika, który jest długi, słowny i przytłumiony tekstem. Oszczędź swoich kolegów. Wyrzuć ten pierwszy szkic i planuj poświęcić dużo czasu na przycinanie go.

dlaczego? Bo mniej znaczy więcej. Opracowanie dokumentacji, która jest kompleksowa i skuteczna, a jednocześnie zwięzła, wymaga czasu.

P. S. Nie mówię, żeby wycinać rzeczy dla zwięzłości. Mówię, że zwięzła dokumentacja to sztuka, która nie ląduje za pierwszym razem.

użyj białej przestrzeni.

pomyśl o tym w kategoriach UX (user experience). W ten sam sposób, w jaki zależy ci na tym, aby baza danych była przyjazna dla użytkownika, chcesz również, aby podręcznik był łatwy do przeglądania.

im więcej jest białych spacji – odstępy między/wokół tekstu – tym lepiej. Weź również pod uwagę rozmiar czcionki, wysokość linii i odstępy między punktorami.

używaj zrzutów ekranu tylko tam, gdzie musisz.

zrzuty ekranu są fantastyczne. Po co komuś coś tłumaczyć, skoro można mu też pokazać?

ale ja osobiście uważam, że to jakaś pułapka. Przynajmniej jeśli chodzi o dokumentację.

pomyśl o tym. Jeśli coś się zmieni w interfejsie systemu, będziesz musiał ponownie pobrać i zastąpić te obrazy. Mogą również odwrócić uwagę od twoich pisemnych instrukcji, zwłaszcza jeśli dasz się ponieść emocjom.

dlatego używam ich głównie do podkreślenia czegoś, czego moi użytkownicy mogliby przegapić.

🌟 jeszcze jedna rzecz, która może pomóc….

teraz, gdy mamy już swoje kroki, czas zacząć budować! Aby pomóc, stworzyłem szablon instrukcji obsługi, który udostępniam każdemu, kto chce – dla Microsoft Word lub Google Docs!

wszystko czego potrzebujesz to adres e-mail. Aby to sprawdzić i pobrać kopię, kliknij ten link.

ponieważ jest to blog bazy danych, jedna szybka Uwaga! Rejestrując się, aby otrzymać szablon, zostaniesz również dodany do listy e-mailowej mojego bloga (której nigdy nie udostępniam osobom trzecim). Wysyłam co dwa miesiące aktualizacje i okazjonalne ogłoszenia, z których możesz zrezygnować w dowolnym momencie.