PHP
Contribuer au manuel PHP
Recherche…
Introduction
Le manuel PHP fournit à la fois une référence fonctionnelle et une référence de langage avec des explications sur les principales fonctionnalités de PHP. Le manuel PHP, contrairement à la documentation de la plupart des langages, encourage les développeurs PHP à ajouter leurs propres exemples et notes à chaque page de la documentation. Cette rubrique explique la contribution au manuel PHP, ainsi que des conseils, astuces et directives pour les meilleures pratiques.
Remarques
Les contributions à ce sujet devraient principalement décrire le processus de contribution au manuel PHP, par exemple expliquer comment ajouter des pages, comment les soumettre pour examen, trouver des zones pour contribuer au contenu, etc.
Améliorer la documentation officielle
PHP a déjà une excellente documentation officielle sur http://php.net/manual/ . Le manuel PHP documente à peu près toutes les fonctionnalités du langage, les bibliothèques principales et la plupart des extensions disponibles. Il y a beaucoup d'exemples à apprendre. Le manuel PHP est disponible en plusieurs langues et formats.
Mieux encore, la documentation est gratuite pour tous .
L'équipe de documentation PHP fournit un éditeur en ligne pour le manuel PHP à l' adresse https://edit.php.net . Il prend en charge plusieurs services d'authentification unique, y compris la connexion à votre compte Stack Overflow. Vous pouvez trouver une introduction à l'éditeur à l' adresse https://wiki.php.net/doc/editor .
Les modifications apportées au manuel PHP doivent être approuvées par les membres de l'équipe de documentation PHP ayant Doc Karma . Doc Karma est un peu comme la réputation, mais plus difficile à obtenir. Ce processus d'évaluation par les pairs permet de s'assurer que seules les informations factuellement correctes parviennent dans le manuel PHP.
Le manuel PHP est écrit dans DocBook, un langage de balisage facile à apprendre pour les livres de création. Cela peut sembler un peu compliqué à première vue, mais il existe des modèles pour vous aider à démarrer. Vous n'avez certainement pas besoin d'être un expert DocBook pour contribuer.
Conseils pour contribuer au manuel
Voici une liste de conseils pour ceux qui cherchent à contribuer au manuel PHP:
- Suivez les directives de style du manuel . Assurez-vous que les directives de style du manuel sont toujours suivies pour des raisons de cohérence.
- Effectuer des vérifications orthographiques et grammaticales . S'assurer que l'orthographe et la grammaire appropriées sont utilisées - sinon les informations présentées peuvent être plus difficiles à assimiler et le contenu sera moins professionnel.
- Soyez concis dans les explications . Évitez de faire une présentation claire et concise de l'information aux développeurs qui cherchent à la consulter rapidement.
- Séparez le code de sa sortie . Cela donne des exemples de code plus propres et moins compliqués à digérer par les développeurs.
- Vérifiez l'ordre de la section de page . Assurez-vous que toutes les sections de la page de manuel en cours de modification sont dans le bon ordre. L'uniformité du manuel facilite la lecture rapide et la recherche d'informations.
- Supprimez le contenu lié à PHP 4 . Les mentions spécifiques à PHP 4 ne sont plus pertinentes compte tenu de l’ancienneté actuelle. Les mentions de celui-ci doivent être supprimées du manuel pour éviter de le convoler d’informations inutiles.
- Fichiers de version corrects . Lors de la création de nouveaux fichiers dans la documentation, assurez-vous que l'ID de révision du fichier est défini sur rien, comme ceci:
<!-- $Revision$ -->. - Fusionner des commentaires utiles dans le manuel . Certains commentaires apportent des informations utiles dont le manuel pourrait bénéficier. Ceux-ci doivent être fusionnés dans le contenu de la page principale.
- Ne cassez pas la documentation . Assurez-vous toujours que le manuel PHP se construit correctement avant de valider les modifications.