Witaj na Forum Linuxiarzy
Zanim zalogujesz się, by pisać na naszym forum zapoznaj się z kilkoma zasadami savoir-vivre'u w wątku Administracja-> Przywitaj się. Wątki z problemami zamieszczone w dziale "Przywitaj się" będą usuwane.

Autor Wątek: Dokumentacja w linuksie  (Przeczytany 246 razy)

Offline pavbaranov

  • Hero Member
  • *****
  • Wiadomości: 1334
Dokumentacja w linuksie
« dnia: Czerwiec 13, 2019, 01:15:37 pm »
Chcecie - macie :) (To a propos schodzącego na manowce wątku https://linuxiarze.pl/forum/index.php/topic,3351.0.html i pobocznej dyskusji nt. dokumentacji w linuksie, która się tam pojawiła).

A zatem: co, gdzie i jak? Czego ta dokumentacja ma dotyczyć, gdzie ma być dostępna, w jaki sposób, a w końcu, kto taką dokumentację winien stworzyć? Istota problemu leży po stronie twórców (oprogramowania, czy dystrybucji), czy też po naszej, bowiem być może owa dokumentacja (wciąż nie wiemy o jaką chodzi) jest, a tylko użytkownik nie potrafi jej znaleźć?

Pewnie nie byłbym sobą, gdybym nie miał własnego zdania, a zatem by zagaić:
1. Dokumentacja. Wg mnie można mówić o niej co najmniej w dwu aspektach. Pierwszy to kod źródłowy i dokumentowanie (komentowanie) dokonywanych tu zmian. Drugi to dokumentacja użytkownika.
Nie będę się powtarzać, ale przeglądnąwszy już dziesiątki linijek kodu, wydaje mi się, że przynajmniej spora jego część, a na pewno spora część tzw. "dużych" projektów, ma dokumentację na tym poziomie dość prawidłowo zrobioną. Pozostaje kwestia dokumentacji dla użytkownika, która bywa mniej lub bardziej szczegółowa, ale - jest. Twierdzenie, że jej nie ma jest absolutną hucpą. Być może nie jest ona łatwa do odnalezienia przez użytkownika, być może nawet jak na nią wpadnie, to jej nie rozumie, być może też ktoś chciałby po polsku, a tu głównie w języku angielskim (i w miarę szczęście, gdy w takim).
2. Kto powinien tworzyć? Oczywiście dokumentację kodu - ten, kto ów kod pisze. Dokumentację dla użytkownika może już jednak robić zarówno ten, kto program pisze, jak i ten, kto go po prostu zna. Jak powiedziałem - często ta dokumentacja jest, ale bywa, że nie jest ona dostępna off-line. I słusznie. Dokumentacja takiego np. Photivo to teksty, podzielone na kilka grup, tutoriale i materiał wideo. To zaledwie jeden program. W moim systemie mam nieco paczek i gdyby każdy taki program został obudowany w tego typu materiał dostępny off-line, instalowany na dysku, to wkrótce okazałoby się, że oprócz setek materiałów, które nie są mi już potrzebne (bo się nauczyłem, bo znam), miałbym zawalony cały dysk wyłącznie dokumentacją. Niech ona sobie zatem będzie tam, gdzie jest, czyli "w internecie".
Faktem jest, że dystrybucje różnie podchodzą do swoich powinności w zakresie "dokumentacji", ale powiedzmy sobie szczerze: tych dystrybucji "pierwotnych" jest dosłownie 5 na krzyż i one zostały udokumentowane. Jest opisana instalacja, są opisane podstawy korzystania z systemu. I tyle winno być, albowiem opis programu winien być po stronie tej aplikacji, czy ich zbioru. I znów w internecie.
3. Jeszcze chyba nie znalazłem materiału, który by mnie interesował (czyt. potrzebowałbym pomocy w zakresie używania oprogramowania), dla którego nie znalazłbym dokumentacji. Jeśli ktoś zna - proszę o przykład. Wg mnie istotą problemu jest brak umiejętności znalezienia tego materiału, ale to już jest problem leżący po naszej, użytkowników stronie. Niekiedy też problem leży w braku umiejętności przyswojenia takiego materiału, ale tu nikt za kogoś, tego przecież nie zrobi. Sam jakąś tam wiedzą nt. oprogramowania, zasad korzystania itp. itd. z "linuksa" dysponuję, ale do tej wiedzy doszedłem sam. To, co dzisiaj umię, zawdzięczam wyłącznie sobie oraz tym, którym się chciało... no właśnie - umieścić w sieci dokumentację. To przecież z niej się tego nauczyłem, a nie zostałem jaśnie oświecony (powtarzam - jestem z pokolenia, gdzie informatyki w szkole nie było; ba PC-tów nie było).
4. Często słyszę: no, ale to nie jest po polsku. Ok, nie jest. A ile jest oprogramowania FLOSS tworzonego przez Polaków? Ile mamy polskich projektów? Mocno niewiele. Dodatkowo często osoby, które piszą to oprogramowanie i robią dokumentację w języku angielskim (bo najpopularniejszy), nie mają już czasu, by tworzyć ją w innym języku, a nadto jeszcze zajmować się kodem (bardzo często w sposób społeczny, z którego korzystamy w zamian bardzo rzadko cokolwiek dając). Kto zatem powinien dokonać tego spolszczenia, jak nie my? A jeśli tak, to kto? Wg mnie ten, kto tego potrzebuje. Mi do szczęścia nie jest potrzebna dokumentacja w języku polskim, a zatem mocno mało jestem zainteresowany jej tworzeniem. Mógłbym, ale... po co? Musiałbym jeszcze to gdzieś utrzymywać, płacić za hosting tego itp. itd. Wychodzę też z założenia, że jeśli coś już jest, to po co powielać. Fakt, że w innym języku, ale ten mi wystarcza - jeśli komuś potrzebny jest po polsku, to... to niech to sobie przetłumaczy we własnym zakresie i - wzorem twórców oryginalnego tekstu oraz oprogramowania - odda to społeczności. Skoro wymagamy otwartych źródeł, skoro wymagamy oprogramowania o konkretnej funkcjonalności, dokumentacji i tego wszystkiego najczęściej za darmo, to zróbmy to samo - oddajmy innym to, czym dysponujemy.
I na razie tyle dla ewentualnego zainicjowania dyskusji.

Offline TataPingu

  • Hero Member
  • *****
  • Wiadomości: 1319
Odp: Dokumentacja w linuksie
« Odpowiedź #1 dnia: Czerwiec 13, 2019, 02:11:10 pm »
W sumie nic dodać, nic ująć, Pawle...
- ciekawy jestem odzewu i dalszych dywagacji na ten temat...