A FreeBSD Dokumentációs Projekt irányelvei kezdőknek
Előző |  | Következő

# Fejezet 1. Áttekintés

Üdvözöljük a FreeBSD Dokumentációs Projektben! A FreeBSD sikerességéhez elegendhetetlenül fontos a jó minőségű dokumentáció, amelynek jelentős részét a FreeBSD Dokumentációs Projekt (röviden FDP) állítja elő. Ez a projekt rendkívül értékesnek tart bármilyen fajta támogatást.

Ennek a dokumentumnak fő célja, hogy bemutassa az FDP szerveződését, hogyan készítsünk és küldjünk az FDP részére dokumentációt, és hogyan használjuk hatékonyan a dokumentációk írásához készített eszközöket.

Az FDP bárkit szívesen fogad. A tagságnak nincs semmiféle előfeltétele, a tagoknak nem kötelező havonta adott mennyiségű dokumentációk írniuk. A belépésnek mindössze annyit kell tennünk, hogy feliratkozunk a FreeBSD Dokumentációs Projekt levelezési lista tagjai közé.

A könyv elolvasása során megismerjük:

- milyen dokumentációkat tart karban az FDP;

- az FDP által karbantartott dokumentációk megírásához használt SGML nyelvet;

- hogyan készítsünk módosításokat a dokumentációhoz;

- hogyan küldjük be és nézessük át a módosításainkat, ezek miként kerülhetnek be a FreeBSD hivatalos dokumentációjába.

# 1.1. A FreeBSD dokumentációja

Az FDP a FreeBSD-hez mellékelt dokumentációk négy fajtájáért felelős:

Man oldalak

  Az angol nyelvű man oldalakat nem az FDP tagjai készítik, azok az alaprendszer részei. Az FDP viszont az olvashatóság vagy az esetleges pontatlanságok javítása érdekében át tudja fogalmazni ezeket.

  Továbbá a különböző fordítói csoportok felelősek a rendszerhez tartozó egyes man oldalak fordításaiért, amelyek szintén az FDP keretein belül készülnek.

GYIK

  A GYIK célja a FreeBSD-vel foglalkozó különböző levelező listákon és hírcsoportokon felbukkanó gyakran ismételt kérdések (rövid, lényegretörő) megválaszolása. Ez a formátum nem teszi lehetővé hosszabb és minden részletre kiterjedő válaszok megfogalmazását.

Kézikönyv

  A kézikönyv a FreeBSD felhasználók számára összeállított átfogó, intereten keresztül is olvasható referencia.

Honlap

  A http://www.FreeBSD.org/ címen, illetve annak különböző tükrözésein keresztül elérhető honlapok képviselik a FreeBSD elsődleges megjelenési formáját a világhálón. Legtöbben ezen az oldalon találkoznak a FreeBSD-vel először.

Az imént felsorolt kategóriák mindegyike megtalálható a FreeBSD repositoryjában, ezért a velük kapcsolatos változtatásokhoz tartozó naplóbejegyzések mindenki számára láthatóak, illetve a CVSup vagy CTM alkalmazások használatával a dokumentációkból létre tudunk hozni egy helyi másolatot.

Mindezek mellett sokan készítettek további oktatóanyagokat és FreeBSD-hez kapcsolódó honlapokat. Ezek némelyike (a szerző előzetes engedélyével) a repositoryban is megtalálható. A többi esetben a szerzők úgy döntöttek, hogy a FreeBSD forrásaitól független helyen szeretnék tárolni a leírásaikat. Ilyenkor pedig az FDP törekszik belinkelni ezeket.

Előző | Tartalom | Következő
Köszönetnyilvánítás |  | Mielőtt belekezdenénk

Ha kérdése van a FreeBSD-vel kapcsolatban, a következő címre írhat (angolul): <freebsd-questions@FreeBSD.org>.
Ha ezzel a dokumentummal kapcsolatban van kérdése, kérjük erre a címre írjon: <gabor@FreeBSD.org>.