Dokumentacja

W bardzo, bardzo dawnych czasach, które nazywaliśmy epoką kamienia łupanego, człowiek, a może jego przodek, zaczął wykazywać coraz większe zdolności do ułatwiania sobie życia. Powiedzmy, że była to wrodzona cecha człowieka. Nasz przodek tworzył różne przedmioty, które ułatwiały tworzenie nowych, bardziej dokładnych i nowocześniejszych wynalazków. I tak wszystko zaczęło się kręcić, że w dzisiejszych czasach doświadczamy cudów techniki, które zaspokajają nasze coraz większe potrzeby i sprawiają wygodę, bez której nie wyobrażamy sobie już życia.

Jak przekazywano myśl techniczną?

Możemy się zastanowić nad tym, jak to się stało, że mogliśmy ogarnąć cały dorobek ludzkości i wykorzystywać pomysły wynalazców sprzed wielu wieków, łączyć je na wszelkie sposoby i tworzyć własne rewolucyjne myśli techniczne. Jak to się stało, że wiemy jak coś trzeba zrobić, żeby to coś działało? Co jest powodem tego, że nikt nie zapomniał o dawnych wyczynach i pomysłach? Czy to wszystko jest przekazywane w genach, czy raczej ewoluujemy w sposób, który umożliwia nam zrozumienie wszystkich zachodzących zjawisk w przyrodzie? Otóż myślę, że nie, chociaż ktoś może mieć inne zadanie i nie mogę tego całkowicie odrzucić - świat nigdy nie będzie do końca zbadany. Myślę, że możemy wykorzystywać wiedzę i miliony pomysłów pozostawionych nam przez wybitnych naukowców i wynalazców, ponieważ zostały one odpowiednio udokumentowane. Dokumentacją możemy nazwać książkę opisującą jakieś osiągnięcie, artykuł w gazecie, nagranie, film dokumentalny, czy nawet malowidła na ścianach, które często można zobaczyć w piramidach. Dzięki takim zabiegom można w bardzo prosty sposób zrozumieć i odtworzyć wiedzę, której zdobycie zajęło naszym poprzednikom nawet całe ich życie. Umiejętność pisania dokumentacji jest więc bezcenna, a dokumentować można dosłownie wszystko.

Czym jest dokumentacja?

Każde słowo uwiecznione w dowolny sposób jest dokumentacją. Weźmy na przykład książkę “Alicja w krainie czarów”. Wielu może powiedzieć, że jest to nieistotne dzieło, bajka dla dzieci, której nawet się nie czyta - równie dobrze mogłoby tego nie być. Otóż, nawet ta książka jest dokumentacją. Dokumentacją, która przekazuje myśl jej autora, coś co autorowi przyszło do głowy i teraz jest źródłem inspiracji dla wielu artystów, dla mnie i dla Ciebie, i każdy kto przeczyta tą książkę lub jakąkolwiek inną, staje się bogatszy o dodatkowe wrażenia. Czytajcie książki, oglądajcie filmy, słuchajcie muzyki!

Korzyści wynikające ze stosowania dokumentacji

Dzięki dobrze stworzonej dokumentacji możemy zawsze odtworzyć to co już kiedyś, z wielkim mozołem, wymyśliliśmy. Mamy tendencję do zapominania, jeśli czegoś nie powtarzamy i dlatego zapisywanie wszystkiego pomaga nam to uwiecznić. Możemy sobie wyobrazić, że prowadzimy firmę, gdzie razem z naszymi kolegami, przez całe lata, wypracowaliśmy całą skomplikowaną technologię wytwarzania naszych produktów. Każdy jest specjalistą w pewnym zakresie i ogrom całej wiedzy nie pozwala na to, żeby jedna osoba mogła perfekcyjnie wszystkiego się nauczyć. Co się stanie kiedy cały nasz skład się rozejdzie? Nasza wspólna wiedza zniknie i nikt nie będzie potrafił w łatwy sposób pojąć tego na nowo w taki sam sposób. Jeśli jednak zachowamy wiedzę każdej z tych osób, to nowy skład będzie mógł szybko odtworzyć stan tej zaawansowanej technologii. Przypadek piramid najlepiej może nam to wszystko dobitnie uświadomić. Co by było, gdyby zachowały się księgi dokładnie opisujące technologie używane do ich budowy? Świat wyglądałby teraz całkiem inaczej.

Wiele firm tworzących dokładną dokumentację może bardzo szybko przekształcić się w potężną firmę, która dokładnie zna swoje możliwości i nie zapomina o wiedzy i doświadczeniach, które były przez wiele lat ciężko wypracowywane. Wykwalifikowany pracownik, który coś opracował, odchodząc z firmy często zabiera całą wiedzę razem ze sobą. Organizacja może popaść w kłopoty, nie radząc sobie z pewnymi operacjami, które były wykonywane przez tego pracownika. Prowadząc dokumentację zyskujemy na czasie oraz wypracowujemy sobie przewagę nad konkurencją, ponieważ powtarzając daną operację nie musimy każdorazowo na nowo dochodzić do rozwiązań, które wcześniej zostały opracowane.

Z powodu braku dobrej i zrozumiałej dokumentacji, codziennie ginie wiele doskonałych projektów, które mogłyby zrewolucjonizować nasze życie. W świecie technologii jest jednak widoczny trend, który wskazuje na to, że świat zauważa jak ważne jest dokładne dokumentowanie osiągnięć. Istnieje wiele projektów, które swą ogromną popularność zawdzięczają temu, że dzięki zrozumiale napisanej dokumentacji, ludzie w łatwy sposób mogą nauczyć się jak korzystać z tego dzieła.

Człowiek z natury zapomina o tym jak coś wymyślił

Ludzka pomysłowość oraz dokumentowanie pomysłów i myśli jest prawdopodobnie najbardziej znaczącym ogniwem w rozwoju naszej cywilizacji.

Wiedząc już jak ważna jest dokumentacja, musimy zająć się wypracowaniem odpowiedniego sposobu jej zapisywania i przechowywania, żeby informacja była uporządkowana, dawała się łatwo i szybko odszukać oraz nie zginęła w gąszczu mozolnie zbieranych dokumentów. Poniżej postaram się wypracować lub naprowadzić Cię na odpowiednią formę stosowania i porządkowania tej informacji.

Wskazówki dotyczące tworzenia dokumentacji

Jeśli chodzi więc o tworzenie dokumentacji, to każda forma jej stosowania, nawet uproszczone notatki są o wiele lepsze niż nic. Dokumentacja może być opisowa oraz może być ubrana w formę, którą sam wybierzesz, może wyglądać dowolnie. To, że masz swobodę w tworzeniu dokumentacji i jej formie, może być najkrótszą drogą, żeby zachęcić Cię do jej pisania. Chciałbym tutaj jednak zaznaczyć, że w dalszej perspektywie o wiele lepsze jest usystematyzowanie sposobu pisania dokumentacji, aby wszystkie Twoje opisy miały podobną strukturę i formę. Okazuje się to bowiem bardzo przydatne, gdy napiszesz już bardzo wiele dokumentów i pojawi się potrzeba szybkiego wyszukiwania informacji. Jeśli więc masz swój system, np. kolorem czerwonym zaznaczasz tytuł a kolorem zielonym rozdziały, a te znowu są uporządkowane w każdym dokumencie w podobny sposób, to możesz szybko odnaleźć odpowiedni fragment. Warto stworzyć ogólny spis rozdziałów, które koniecznie mają się znaleźć w takim dokumencie np. pierwszy rozdział ma być ogólnym opisem, drugi rozdział powinien zawierać potrzebę stworzenia opisywanej rzeczy (usługi itp.), trzeci - opis techniczny rozwiązania, czwarty - możliwości wykorzystania w przyszłości, czwarty - wnioski. Każdy pomysł jest dobry pod warunkiem, że nie wprowadza chaosu. Jeszcze jedną bardzo ważną rzeczą, o której należy pamiętać, jest to, że dokumentacja powinna być jak najbardziej zwięzła i przekazywać jak najwięcej. Nie może być więc zbyt krótka i niezrozumiała, ale też nie może być zbyt długa i nie przenosząca sensownej informacji. Stosowanie tych wskazówek pomoże utrzymać porządek.

Porządkowanie dokumentacji

Podczas dokumentowania i gromadzenia naszej wiedzy po pewnym czasie może się okazać, że nie możemy odnaleźć pewnych stworzonych przez nas informacji, pomimo że istnieją one w naszym zbiorze danych. Jednym z powodów takiego stanu rzeczy jest to, że dokumenty nie są odpowiednio posortowane i opisane. Mogę tutaj przekazać kolejną wskazówkę, która mówi, żeby stosować (w przypadku, gdy stosujemy komputerową dokumentację) podział na katalogi i podkatalogi. Ważne jest też żeby nie było ich za wiele i żeby były rodzajem kategorii np. dom, samochód, praca itd. Te zaś mogą posiadać podkatalogi np. dom może zawierać takie podkatalogi jak przepisy kuchenne, zakupy, remonty itd. Taka struktura od ogółu do szczegółu pozwala na szybkie znalezienie się w miejscu, gdzie znajduje się odpowiedni plik. Kolejnym jednak problemem może być znalezienie tekstu, który np. napisano 1 września 2007 r. Problem może rozwiązać dodanie do nazwy przyrostka zawierającego datę np. w katalogu przepisy mamy sernik z rodzynkami, to plik możemy nazwać sernikRodz070901. Oczywiście każdy może wymyślić swoje standardy. Można np. co roku tworzyć nowe katalogi i opisywać je kolejnym rokiem. Sposobów jest więc bardzo wiele. Najważniejsze, co należałoby zapamiętać to konieczność stworzenia sobie odpowiedniego systemu tworzenia dokumentacji i najlepiej opisać go w osobnym dokumencie i potem stosować konsekwentnie.