Tylko czytelnie

Pisanie dokumentacji jest pewnego rodzaju sztuką. Głównie chodzi o to, aby czytająca ją osoba, która nie była zaangażowana w jej tworzenie, cokolwiek z tego rozumiała.

Pisanie dokumentacji jest pewnego rodzaju sztuką. Głównie chodzi o to, aby czytająca ją osoba, która nie była zaangażowana w jej tworzenie, cokolwiek z tego rozumiała.

Przez ręce Lokalnego Informatyka przechodzi wiele różnych dokumentacji. Zarówno tych tworzonych przez programistów firmowych, jak też dostarczanych z systemami kupowanymi niezależnie. Czasami jednak trzeba się nieźle nabiedzić, aby z lektury tej wyciągnąć jakąś średnią obrazującą zasady funkcjonowania oprogramowania. Lokalny Informatyk pociesza się przy tej okazji, że programy są chyba napisane bardziej logicznie aniżeli dokumentacja, którą czasami przychodzi mu czytać. No bo jakie zdanie można mieć o literackiej twórczości autorów oprogramowania, którzy tworzą "kwiatki" prozy, jak poniżej przytoczone. O przestrzeganiu zasad interpunkcji trudno nawet marzyć.

"Aby zaznaczyć opcję aktywny trzeba sprawdzić czy opcja ta nie jest aktywna bo jak jest to nie można jej zaznaczyć bo jest już aktywna co powoduje, że zamiast ją zaznaczyć to się ją wygasi i wtedy będzie nieaktywna zamiast aktywna i będzie trzeba ją znowu zaznaczyć żeby była aktywna jeśli się to zauważy".

"Uprawnienia do używania zasobu może nadawać użytkownik uprawniony, który nadaje uprawnienia innym bo ma uprawnienia zaznaczone na zakładce uprawnienia aby nadawać uprawnienia".

"Uruchomienie tej procedury skutkuje jej uruchomieniem".

"Program realizuje wiele funkcji. Jest nią ewidencja klientów".

"Aby nie doszło do nadpisania danych przez innego użytkownika są one blokowane żeby inny użytkownik nie mógł robić edycji gdy ktoś inny wykonuje zmianę danych dlatego inny użytkownik nie może w tym samym czasie zmienić tego co ktoś inny teraz wprowadza".

"W przypadku zauważenia że nie wszystkie dane zostały przetransmitowane należy wykonać ponownie transmisję bo wtedy dane które nie zostały wysłane zostaną a dane które były wysłane nie zostaną wysłane to znaczy dane te zostaną na serwerze a te wysłane nie".

"W przypadku problemów z tą funkcją należy użyć zakładki dotyczącej rozwiązywania problemów które pojawiają się gdy są problemy z funkcjami o niestandardowym działaniu".

"Parametry można przekazywać w różny sposób zależny od zastosowania parametrów jednak nie warto przesadzać bo nie wszystkie parametry są dobrze traktowane".

"W przypadku nie rozumienia dokumentacji drukowanej proponuje się ściągnąć jej wersję elektroniczną".

"Jeśli internet aktualnie nie działa, instrukcję obsługi należało pobrać wcześniej"


TOP 200