Projekt FreeBSD
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Ta strona zawiera szczegółowe informacje o projekcie polegającym na pisaniu tekstów technicznych, który został zaakceptowany w ramach Google Season of Docs.
Podsumowanie projektu
- Organizacja open source:
- Projekt FreeBSD
- Pisarz techniczny:
- The King of Toasters
- Nazwa projektu:
- Tworzenie brakujących stron manpages, dodawanie sekcji PRZYKŁAD do stron manpages
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Tworzenie stron brakujących:
Lista brakujących stron man znajduje się na stronie https://wiki.freebsd.org/MissingManpages. Zacznij pisać jak najwięcej stron z tej listy. Z pomocą mentora znajdź autora lub osobę, która ostatnio zmieniła plik źródłowy, którego dotyczy dana strona pomocy, aby uzyskać informacje ogólne i szczegółowe.
Dodawanie sekcji PRZYKŁAD do stron man:
Na stronach man FreeBSD w wielu miejscach znajdują się sekcje PRZYKŁAD, które opisują podstawowe zastosowanie omawianego narzędzia lub polecenia.
Wik FreeBSD zawiera listę stron man bez przykładów (https://wiki.freebsd.org/ManPagesWithoutExamples). Jeśli warto, dodaj jak najwięcej przykładów do tych stron. W tych sekcjach należy zaproponować ogólny sposób przedstawienia polecenia lub narzędzia (np. najpierw szybki start, a potem bardziej zaawansowane przykłady) i zastosować go do stron man opisujących podobne narzędzia lub polecenia. Dzięki temu przykłady są spójne, a czytelnik może łatwiej je znaleźć.
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-07-25 UTC.
[[["Łatwo zrozumieć","easyToUnderstand","thumb-up"],["Rozwiązało to mój problem","solvedMyProblem","thumb-up"],["Inne","otherUp","thumb-up"]],[["Brak potrzebnych mi informacji","missingTheInformationINeed","thumb-down"],["Zbyt skomplikowane / zbyt wiele czynności do wykonania","tooComplicatedTooManySteps","thumb-down"],["Nieaktualne treści","outOfDate","thumb-down"],["Problem z tłumaczeniem","translationIssue","thumb-down"],["Problem z przykładami/kodem","samplesCodeIssue","thumb-down"],["Inne","otherDown","thumb-down"]],["Ostatnia aktualizacja: 2025-07-25 UTC."],[],["The FreeBSD Project, in collaboration with technical writer \"The King of Toasters,\" will undertake a technical writing project focused on man pages. The project includes creating missing man pages from a specified list, using source file authors for guidance. Additionally, the project will add EXAMPLE sections to existing man pages that lack them, following a consistent structure of introductory and then advanced examples to improve readability and usability. The project duration will be three months.\n"]]
