Cette page contient les détails d'un projet de rédaction technique accepté pour la Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- Projet FreeBSD
- Rédacteur technique:
- Le roi des grille-pains
- Nom du projet:
- Écrire les pages man manquantes, ajouter des sections "EXAMPLE" aux pages man
- Durée du projet:
- Durée standard (3 mois)
Project description
Écrire les pages man manquantes:
Vous trouverez une liste des pages de manuel manquantes sur https://wiki.freebsd.org/MissingManpages. Commencez à rédiger autant de pages de manuel que possible dans cette liste. Avec l'aide de votre mentor, recherchez l'auteur ou une personne qui a récemment modifié le fichier source concerné par la page de manuel en question pour obtenir des informations générales et des détails.
Ajouter des sections EXAMPLE aux pages de manuel:
Les pages de manuel de FreeBSD incluent, à de nombreux endroits, une section "EXAMPLE", qui décrit l'utilisation de base de l'utilitaire ou de la commande décrite. Le wiki FreeBSD contient une liste de pages de manuel sans exemples (https://wiki.freebsd.org/ManPagesWithoutExamples). Ajoutez autant d'exemples que possible à ces pages de manuel lorsque cela est pertinent. Trouvez une manière générale d'introduire la commande/l'utilitaire dans ces sections (par exemple, démarrage rapide d'abord, exemples plus avancés par la suite) et appliquez-la aux pages de manuel décrivant des utilitaires/commandes similaires. De cette façon, les exemples ont une approche cohérente et le lecteur peut trouver les choses plus facilement.