PHP Conseils pour contribuer au manuel


Exemple

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.