Pisanie dokumentów jest jak sortowanie wypranych ubrań

Umiecie odpowiednio posortować wyprane ubrania? Jeśli tak, to prawdopodobnie umiecie też pisać dokumentację. Brzmi dość dziwnie, jednak okazuje się, że te dwa procesy mogą mieć ze sobą wiele wspólnego.

Niedawno Tom Johnson, autor blogu I'd Rather Be Writing, otrzymał pytanie od swojego czytelnika dotyczące tworzenia dokumentacji od zera. Przez ostatnie kilka lat czytelnik głównie utrzymywał istniejącą dokumentację i czuł się mocno zagubiony, ponieważ dostał zadanie napisania całkowicie nowej dokumentacji, o czym nie za bardzo miał pojęcie.

Tom doradził, żeby zacząć od określenia zadań jakie użytkownicy będą chcieli wykonać za pomocą opisywanej aplikacji. To da nam dobry punkt wyjścia. Dalszą część procesu Tom wyjaśnił na przykładzie... sortowania wypranych ubrań 😊

Krok 1 - zbieramy wszystkie ubrania

Na początek trzeba zebrać wszystkie ubrania w jednym miejscu. Zajmuje to całkiem sporo czasu, szczególnie jeśli ma się dużo dzieci. Kiedy tworzymy dokumentację, musimy spędzić trochę czasu zbierając informacje od ekspertów, ze specyfikacji technicznych, spotkań oraz prezentacji. Kiedy już mamy to co trzeba, tworzymy jeden duży plik, do którego wklejamy wszystkie informacje jakie udało nam się zebrać.

Krok 2 - rozdzielamy ubrania

Kolejny krok polega na podzieleniu ubrań. Możemy do tego użyć koszy. Główne zadanie polega na włożeniu odpowiedniego ubrania do odpowiedniego kosza. Czasami trzeba się dobrze przyjrzeć, żeby się nie pomylić. Na tym etapie musimy podzielić nasz jeden duży plik na kilka mniejszych. Właściwe pogrupowanie informacji nie powinno nam sprawić większych problemów.

Krok 3 - składamy ubrania

Teraz przyszedł czas na uporządkowanie ubrań w koszach. W tym celu wysypujemy zawartość każdego kosza i grupujemy w osobnych kupkach koszulki, spodnie i bieliznę. Następnie składamy wszystkie ubrania. To samo robimy z naszymi dokumentami, które stworzyliśmy w poprzednim kroku - dzielimy informacje zawarte w nich na mniejsze sekcje. Następnie każdą sekcję dzielimy na listy wypunktowane.

Krok 4 - odkładamy ubrania na właściwe miejsce

W tym kroku musimy umieścić ubrania we właściwym pokoju oraz szafie czy komodzie. Na tym etapie zaczyna się pisanie. Przeształcamy sekcje z listami na właściwe zdania. Nie powinno być to bardzo trudne, ponieważ już posiadamy zarys tego co trzeba opisać.

Krok 5 - sprawdzamy

Ostatni krok polega na weryfikacji czy ubrania trafiły we właściwe miejsca. Właściciele każdego zestawu ubrań sprawdzają czy nastąpiły jakieś pomyłki. Jeśli tak, to przekładają oni poszczególne rzeczy tam gdzie powinny były się znaleźć. Ten proces trwa zazwyczaj kilka dni. W przypadku dokumentacji sytuacja jest podobna. Eksperci sprawdzają to co napisaliśmy. Jeśli brakuje czegoś to informują nas o tym. Po wprowadzeniu poprawek instrukcja jest gotowa

Bonus

Tutaj analogia kończy się 😊 Dodatkowo możemy wzbogacić naszą dokumentacę o zrzuty ekranu, diagramy, ilustracje albo inne elementy wizualne, żeby ją trochę ożywić.

Proste, prawda? Życzymy powodzenia w "sortowaniu". W następnych wpisach zajmiemy się sprzątaniem i pieczeniem ciast 😉

Oryginalny artykuł możecie znaleźć tutaj.

P.S. Głosowanie na Blog Roku 2014 i tekst roku trwa tylko do dzisiaj do godziny 12:00. Jeśli czujecie nieodpartą chęć zagłosowania na nasz portal lub tekst to nie walczcie z tym 😊