#use wml::debian::template title="La documentation" #use wml::debian::translation-check translation="1.88" maintainer="Guillaume Delacour" # Premier traducteur: Frédéric Bothamy, 2007

La documentation est une partie importante de tout système d'exploitation car elle englobe les manuels techniques qui décrivent le fonctionnement et l'utilisation des programmes. Dans le cadre de la création d'un système d'exploitation libre de haute qualité, le « Projet Debian » s'efforce de fournir à tous ses utilisateurs une documentation facilement accessible.

Démarrage rapide

Si vous ne connaissez pas Debian, nous vous recommandons de commencer par lire :

Ayez ces documents à disposition quand vous faites votre première installation de Debian, ils répondront probablement à un grand nombre de questions et ils vous aideront à travailler avec votre nouveau système Debian. Par la suite, vous pouvez consulter :

# TODO: changer l'url par http://xinocat.com/refcard/ ?

Enfin, assurez-vous d'imprimer et d'avoir sous la main la carte de référence Debian GNU/Linux, une liste des commandes les plus importantes pour les systèmes Debian.

Si vous voulez commencer à développer des paquets pour Debian, nous vous recommandons de consulter :

Il existe également plusieurs autres documentations listées ci-dessous.

Types de documentation

La plupart de la documentation disponible avec Debian est issue de la documentation écrite pour le système GNU/Linux. Il existe, toutefois, des documents spécifiques à Debian, classés selon les catégories suivantes :

Les manuels

Comparables à des livres, les manuels décrivent des sujets précis de manière très détaillée.

Les manuels spécifiques à Debian

Manuels pour les utilisateurs

Manuels pour les développeurs

Manuels divers

La liste complète des manuels et des documents Debian est disponible sur les pages web du Projet de Documentation Debian.

Il existe également plusieurs manuels destinés aux utilisateurs et écrits pour Debian GNU/Linux, disponibles sous la forme de livres imprimés.

Manuels pour GNU/Linux en général

Les documents et manuels Linux les plus populaires sont le Guide d'installation et de démarrage de Linux, le \ Guide de l'utilisateur Linux, le Guide de l'administrateur réseau et le Guide de l'administrateur système.

La documentation Linux est coordonnée grâce aux efforts du Projet de documentation Linux (LDP en anglais). Vous trouverez l'intégralité des manuels du LDP sur leur page web, ainsi que beaucoup d'autres documents, sous une forme électronique et imprimée.

Les HOWTO

Les documents HOWTO, comme leur nom l'indique en anglais, décrivent comment faire quelque chose et ils couvrent habituellement un sujet bien spécifique.

Parmi les HOWTO Linux les plus importants il y a :

Vous pouvez également les installer sur votre propre machine grâce aux paquets \ doc-linux-text et \ doc-linux-html.

# TODO: make a note about the translated doc-linux-* packages...

Les FAQ

Le sigle FAQ signifie foire aux questions. Une FAQ est un document qui répond aux questions les plus fréquemment posées.

La FAQ Linux contient des informations concernant Linux en général.

Les questions spécifiques à Debian sont traitées dans la FAQ Debian. Il existe également une FAQ sur les images CD/DVD Debian.

Veuillez consulter l'index des FAQ LDP pour plus d'informations.

Les autres documents plus concis

Les documents suivants fournissent des instructions plus concises et rapidement consultables :

les pages de manuel
Traditionnellement, tous les programmes Unix sont documentés par des pages de manuel, accessibles avec la commande man. Elles ne s'adressent habituellement pas aux débutants. Vous pouvez trouver et lire les pages de manuel disponibles dans Debian sur http://manpages.debian.net/.
fichiers info
Un grand nombre de logiciels GNU sont documentés par des fichiers info au lieu de pages de manuel. Ces fichiers incluent des informations détaillées sur le programme lui-même, ses options et des exemples d'utilisation, ils sont disponibles grâce à la commande info.
les divers fichiers README
Les fichiers README (lisez-moi) sont aussi très courants — ce sont de simples fichiers textes décrivant un sujet unique, d'habitude un paquet. Vous en trouverez beaucoup dans le répertoire /usr/share/doc/ de votre système Debian. Chaque paquet a son propre sous-répertoire dans ce répertoire, avec ses propres fichiers README et des exemples de configuration. Veuillez noter que, pour les plus gros programmes, la documentation est habituellement fournie dans un paquet séparé (avec un nom similaire au paquet d'origine, mais se terminant par -doc).
cartes de référence rapide

Les cartes de référence rapide sont des résumés très courts d'un certain (sous-)système. Habituellement, une telle carte de référence fournit les commandes les plus utilisées sur une seule page. Certaines cartes de référence peuvent être trouvées sur :

carte de référence Debian GNU/Linux
Cette carte pouvant être imprimée sur une seule page recto-verso, fournit une liste des commandes les plus importantes et est une bonne référence pour les nouveaux utilisateurs de Debian voulant se familiariser avec celles-ci. Une connaissance de base de l'ordinateur, des fichiers, des répertoires et de la ligne de commande est requise. Les nouveaux utilisateurs peuvent vouloir lire en premier la Référence Debian.
refcards.com
Un regroupement de cartes de référence rapide centrées principalement sur les logiciels libres
cartes de référence rapide
Un regroupement de cartes de référence rapide pour les programmes et langages de programmation les plus populaires

Si vous avez consulté les ressources précédentes et que vous n'avez toujours pas trouvé de réponses à vos questions ou de solutions à vos problèmes concernant Debian, jetez un coup d'œil à notre page dédiée à l'assistance.