Introduction au Projet de Documentation de FreeBSD pour les nouveaux participants
Précédent		Suivant

Chapitre 1. Introduction

Table des matières
1.1. Le jeu de documentations de FreeBSD
1.2. Avant de commencer

Bienvenue au Projet de Documentation de FreeBSD. Une documentation de bonne qualité est un facteur important de succès pour FreeBSD, et le Projet de Documentation de FreeBSD - ``The FreeBSD Documentation Project'' - est la source d'une grande part de cette documentation. Votre participation est importante.

L'objectif principal de ce document est d'expliquer clairement comment est organisé le FDP, comment écrire et soumettre de la documentation au FDP et comment utiliser les outils disponibles pour produire de la documentation.

La participation de chacun au FDP est bienvenue. Il n'y a pas de cotisation minimum, pas de quota de documentation à produire par mois. Il vous suffit de vous inscrire sur la liste de diffusion du groupe de documentation de FreeBSD.

Après avoir lu ce document, vous :

Saurez quelles sont les documentations maintenues par le FDP.
Serez capable de lire et comprendre le code SGML source des documentations maintenues par le FDP.
Serez capable de modifier la documentation.
Saurez comment soumettre vos modifications pour qu'elles soient revues et incorporées à la documentation de FreeBSD.

1.1. Le jeu de documentations de FreeBSD

Le FDP a la responsabilité de quatre catégories de documents.

Les pages de manuel

Les pages de manuel système en anglais ne sont pas rédigées par le FDP, puisqu'elles font partie du système de base. Le FDP, néanmoins, peut (et a) récrit des pages de manuel existantes pour les clarifier ou corriger des inexactitudes.

Les équipes de traductions sont responsables de la traduction des pages de manuel dans les différentes langues. Ces traductions sont archivées par le FDP.

FAQ

L'objectif de la FAQ est de répondre (sous forme de courtes questions/réponses) aux questions qui sont posées, ou devraient être posées, sur les différentes listes de diffusion et forums de discussion consacrées à FreeBSD. Son format n'autorise pas de réponses longues et exhaustives.

Manuel de référence - ``Handbook''

Le Manuel cherche à être la ressource en ligne exhaustive et de référence pour les utilisateurs de FreeBSD.

Le site Web

C'est le point de présence central de FreeBSD sur le World Wide Web, dont le site principal est http://www.freebsd.org/ et qui a de nombreux sites miroirs dans le monde. Pour beaucoup de gens, ce site est leur première rencontre avec FreeBSD.

Ces quatres catégories de documentation sont disponibles dans les archives CVS de FreeBSD. Ce qui signifie que les modifications et les notifications sont accessibles à tous, et que chacun peut utiliser un programme comme CVSup ou CTM pour maintenir à jour son propre exemplaire local.

En plus de ces documents, de nombreuses personnes ont écrit des guides ou réalisé des sites Web se rapportant à FreeBSD. Certains sont aussi archivés dans l'arborescence CVS (quand l'auteur a donné son accord). Dans d'autre cas, l'auteur a choisi de conserver ses documentations en dehors des archives FreeBSD. Le FDP essaie de donner le maximum de liens possible sur ces documents.

Précédent	Sommaire	Suivant
Remerciements		Avant de commencer