🚀 go-pugleaf

W dniu Fri, 17 Nov 2023 23:33:09 GMT, użytkownik Marcin Debowski napisał:

>> Pobawmy się w analizę tego kawałka. Pogapiłem się dłuższą chwilę swoim
>> okiem profana i co widzę:
>> 1. Niekonsekwencja. Piszą "based on name and other attr." A zaraz potem
>> w przykładzie używają słowa "pattern". Ja bym po pierwsze wymienił owe
> 
> To jest nazwa parametru, który wchodzi do lini poleceń. Jest to
> konkretna nazwa, jak zdefiniowana zmienna, do której dalej nastąpią
> odniesienia.
Nie rozumiem. Niby wiem co powiedziałeś ale jak to się odnosi do mojej 
myśli?? Powtórzę - w przykładzie użyli słowa pattern choć w wstępie 
używają słów name/other attributes. Zatem albo w wstępie powinno być 
pattern (of name) albo w przykładzie name/other attributes. Zauważę tu że 
angielskojęzycznych jest na świecie jakieś 5%, cała reszta zna angielski 
źle a przynajmniej gorzej. I proszę nie wspominać o wyjątkach, wiem że się 
zdarzają :) Więc piszący instrukcję powinien być wyjątkowo staranny i 
konsekwentny.
> 

> Argumenty polecenia w sekcji składni czasami są wymienione, a czasem
> nie. Jednym z powodów może być kompleksowość polecenia. Nie potrafię
> powiedzieć czy jest tu jakaś standaryzacja. Co do użyteczności czasami
> się to przydaje, ale akurat przy pkill nie widzę takiej potrzeby.
No cóż, ty nie widzisz a ja widzę.
> 

>> 2. W serii przykładów jest taki z opcją -HUP a jest ona niewymieniona w
>> spisie opcji. Co jest grane?
> 
> OPTIONS
>        -signal --signal signal
Nie rozumiem co ma jedno do drugiego.
> 
>> 3. Zaczynasz czytać mana i od razu chciałbyś zapytać czy np. polecenie
>> pkill nie jest przypadkiem połączeniem ps i kill (i to samo w stosunku
>> do pozostałych dwóch poleceń z p na początku). Jeśli jest lub nie jest
>> to dobrze by było wspomnieć.
> 
> W manie? Po co? Celem man'a jest ogarnięcie polecenia w możliwie zwięzły
> sposób (do szybkiego sprawdzenia w oknie terminala). To nie są strony z
> wikipedii.
Znane mi były od lat polecenia kill, ps, czy grep. Polecenia  typu pkill 
są znacznie późniejsze, kiedy ja się uczyłem jeszcze ich nie wymyślono. W 
istocie dowiedziałem się o nich parę dni temu :) Jeśli taki user jak ja na 
nie trafi będzie tak samo ciekaw. A od SZYBKIEGIO to jest help a nie man, 
który powinien być dużo bardziej wyczerpujący,
> 
>> 4. No i jak mógłbym do przykładów nie dorzucić pkill -x 'name1|name2'
> 
> Jeden specyficzny przykład z kilkunastu-klikudziesięciu grup
> funkcjonalnych regexpa. Można, ale dlaczego własnie ten?
Bo mi go zabrakło. Jak odpytasz grupę userów, każdemu zabraknie czegoś 
innego a ty (tzn. twórca mana) masz z tego zrobić użytek. 
> 
>> Jeśli tego mama pokazać kilkunastu ludziom o rozmaitej linuksowej
>> wiedzy,
>> da się wyciągnąć jakieś konkrety. A daję klacz za capa że nikt tego
>> mana (ani innych) nie konsultował z profanami.
> 
> Pewnie nikt. Jak sam pisze jakąś dokumentację dla odbiorcy technicznego
> to też nie przeprowadzam konsultacji społecznych. Zakładam pewien min
> poziom więdzy jako warunek wejściowy. Jako chemik, miałbym może
> tłumaczyć co to jest chlorek potasu, destylacja, sublimacja, wyjaśniać
> terorię związków chemicznych, wiązań, czy też nie erdolić się i z
> rozmachem zacząć od podstaw fizyki, bo w końcu chemia jest jej pochodną?
> W każdym razie doceniam, że podjąłeś wyzwanie i zacząłeś analizować
> angielskie teksty. Spokojnie dasz radę z tym co się da wyguglać. Dla
> mnie osobiści nieocenionym źródłem przykładów jest Stack Overflow.
> Ptania zadaję tam rzadko - zwykle wystarczy mi co wyrzuca gugiel. Zdaje
> się mają obecnie jakieś kłopoty. Mam nadzieję, że nie znikną.
Skoro piszesz dokumentację bez konsultacji to popełniasz błąd o którym już 
wspomniałem. Dokumentacja nie ma być zrozumiała dla fachowca, ma być 
zrozumiała dla laika. I jeszcze raz powtarzam, zrozumiała to nie zawsze 
musi znaczyć obszerna.

-- 
Jacek