mirror of
https://github.com/goldbergyoni/nodebestpractices.git
synced 2025-10-30 00:57:04 +08:00
create writing-guidelines.polish.md
created
This commit is contained in:
31
.operations/writing-guidelines.polish.md
Normal file
31
.operations/writing-guidelines.polish.md
Normal file
@ -0,0 +1,31 @@
|
||||
# Nasz manifest pisania treści
|
||||
|
||||
Jak zwiększamy komfort czytania i uczenia się dla naszych gości.
|
||||
|
||||
## 1. Proste jest lepsze niż lepsze
|
||||
|
||||
Naszą misją jest ułatwianie czytania i przyswajania wiedzy. Dlatego koncentrujemy się na przekształcaniu skomplikowanych i wyczerpujących tematów w uproszczoną listę, handlujemy przeciążonymi informacjami ze skróconymi i mniej dokładnymi szczegółami, unikamy „łatwopalnych” i kontrowersyjnych tematów i unikamy subiektywnych pomysłów na rzecz ogólnie przyjętych praktyk.
|
||||
|
||||
## 2. Bądź wiarygodny i niezawodny
|
||||
|
||||
Nasi czytelnicy powinni mieć wielką pewność, że przeglądane przez nich treści są wiarygodne. Osiągamy to poprzez włączenie dowodów, takich jak referencje, dane i inne zasoby dostępne na ten temat. Praktycznie staraj się zamieszczać cytaty z wiarygodnych źródeł, wykazywać wzorce, powiązane wzorce projektowe lub wszelkie środki naukowe, aby udowodnić swoje twierdzenia.
|
||||
|
||||
## 3. MECE (Mutually Exclusive and Collectively Exhaustive)
|
||||
|
||||
Oprócz tego, że treść jest znacznie edytowana i niezawodna, przeglądanie w niej powinno również zapewniać pełne omówienie tematu. Nie można pominąć żadnego ważnego tematu.
|
||||
|
||||
## 4. Spójne formatowanie
|
||||
|
||||
Treść jest prezentowana przy użyciu stałych szablonów. Wszelkie przyszłe treści muszą być zgodne z tym samym szablonem. Jeśli chcesz dodać nowe punktory, skopiuj format punktora z istniejącego i wypuść go do swoich potrzeb. Aby uzyskać dodatkowe informacje, zobacz [ten szablon](https://github.com/i0natan/nodebestpractices/blob/master/sections/template.md).
|
||||
|
||||
## 5. To na temat Node.js
|
||||
|
||||
Każda rada powinna dotyczyć bezpośrednio Node.js, a nie ogólnie oprogramowania. Kiedy radzimy zaimplementować ogólny wzorzec / regułę w Node.js, treść powinna koncentrować się na implementacji Node. Na przykład, gdy ze względów bezpieczeństwa zalecamy sanitize danych wejściowych z żądań, należy użyć Node-lingo - „Użyj oprogramowania pośredniego do sanitize danych wejściowych”. Jeśli element nie ma określonej implementacji w Node.js (np. wygląda tak samo w Python i Jaba) - dołącz go do ogólnego elementu kontenera, patrz na przykład pozycja 6.5.
|
||||
|
||||
## 6. Tylko wiodący dostawcy
|
||||
|
||||
Czasami przydatne jest podanie nazw dostawców, którzy mogą rozwiązać niektóre wyzwania i problemy, takie jak pakiety npm, narzędzia open source, a nawet produkty komercyjne. Aby uniknąć przytłaczających długich list lub rekomendować projekty niestabilne i niestabilne, opracowaliśmy następujące zasady:
|
||||
|
||||
- Polecamy tylko 3 najlepszych dostawców - dostawcę, który pojawia się w 3 najlepszych wynikach wyszukiwania (Google lub GitHub posortowane według popularności) dla danego odpowiedniego słowa kluczowego, możemy uwzględnić w naszej rekomendacji.
|
||||
- Jeśli jest to pakiet npm, należy go również pobrać średnio co najmniej 750 razy dziennie.
|
||||
- Jeśli jest to projekt typu open source, musi zostać zaktualizowany przynajmniej raz w ciągu ostatnich 6 miesięcy.
|
||||
Reference in New Issue
Block a user