Czy rozmawiając przez telefon z mechanikiem samochodowym ktokolwiek szukający pomocy zadałby mu pytanie:
“Coś mi stuka w kole, albo gdzieś w okolicy, czy wystarczy, że przywiozę to koło, czy muszę zostawić w warsztacie cały samochód?”
Sytuacja powyżej jest hipotetyczna, ale czy tak pytałby ktokolwiek o zdrowych zmysłach?
Czy ten mechanik byłby w stanie zdiagnozować choćby np. uszkodzony przegub dostając tylko samo koło od samochodu?
A tymczasem wśród szukających pomocy na forum (przypomnijmy - skupionego na zagadnieniach często bardziej skomplikowanych od budowy współczesnego samochodu) sytuacje z:
- niechlujnie opisanym problemem lub wręcz brakiem jakiegokolwiek opisu (“mam podobny problem”)
- opisem opierającym się na przysłowiowej 1 linijce wyrwanej z loga, czy wręcz fragmentarycznym urywku zrzutu ekranu
- usuniętymi (przez “zaiksowanie” czy zamalowanie) ważnymi danymi dla rozwiązania problemu (tu mała UWAGA - są sytuacje, gdy niektóre dane są tzw. danymi wrażliwymi i je należy zamalować, ale najpierw należy się zastanowić czy są to faktycznie dane wrażliwe - przykłady: numer seryjny licznika energii którego właścicielem jest dostawca energii można uznać za dane wrażliwe; ale MAC-adres czy IP występujący w sieci LAN takimi danymi nie są)
są na porządku dziennym.
Wręcz wątków zawierających niewystarczające informacje jest znacznie więcej niż tych przedstawiających problem jak należy.
Co należy zrobić?
Przed pisaniem posta zaznajomić się z podstawowymi metodami pracy z forum (prawidłowe wstawianie kodu, w szczególności YAMLa jest kluczowe) warto zajrzeć w wątki podstawy-forum
Przy pisaniu posta z opisem problemu dostarczyć
- możliwie dużo informacji użytecznych dla osób pomagających - co najmniej fragmenty konfiguracji i logów, ale nie okrojone do granic ostateczności, tylko pokazujące odpowiednio kontekst
- logów czy konfiguracji NIGDY nie podajemy wyłącznie w postaci obrazka lub wideo, zawsze ma to być TEKST, a obrazek lub wideo oczywiście może się też znaleźć (czasem jest nawet pożądany), ale tylko jako coś uzupełniającego tekst lub dla celów ilustracyjnych (tak wiemy, są ekstremalnie nieliczne sytuacje, gdy się nie da inaczej, ale zdecydowana większość, to tekst który można łatwiej lub trudniej skopiować i wkleić oraz odpowiednio sformatować - tu przypomnę o nieużywaniu cytowania! w tym celu)
- być może też ogólną konfigurację HA, HAOS (czy innego serwera, systemu, czy oprogramowania którego pytanie dotyczy)
- linki źródłowe do dokumentacji, czy wręcz ogólne obrazujące dane rozwiązanie techniczne lub programowe, do instrukcji, czy tutoriali, jeśli pytanie odnosi się do takowego, a w ostateczności, jeśli jedyną dokumentację stanowi wideo, to ze wskazaniem kodu czasowego którego pytanie dotyczy (jakkolwiek jeśli ktoś pyta o wideo-tutorial, to niech się najpierw zastanowi czy inni mają czas go oglądać w całości, więc niech będzie to uzupełnione jakąkolwiek dokumentacją w postaci tekstu, oraz tym co powstało w wyniku tego tutoriala)
- opis problemu nawet jeśli jest zawarty w tytule wątku MUSI się znaleźć też w treści tego pierwszego posta
- nawet jeśli swoje pytanie doklejamy do istniejącego wątku, to opis problemu ma być kompletny (na wypadek sytuacji, gdy będzie on stanowił materiał na osobny wątek, czego często nie da się stwierdzić w momencie tworzenia pytania)
- przyjąć zasadę: jeden problem = jeden wątek
PS Pewnie w przyszłości tekst powyżej będzie edytowany, bo raczej nie zawiera wszystkich typowych przykładów negatywnych…