PHP
Bijdragen aan de PHP-handleiding
Zoeken…
Invoering
De PHP-handleiding biedt zowel een functionele referentie als een taalreferentie, samen met uitleg over de belangrijkste functies van PHP. In tegenstelling tot de documentatie van de meeste talen moedigt de PHP-handleiding PHP-ontwikkelaars aan om hun eigen voorbeelden en opmerkingen toe te voegen aan elke pagina van de documentatie. In dit onderwerp wordt de bijdrage aan de PHP-handleiding uitgelegd, samen met tips, trucs en richtlijnen voor best practices.
Opmerkingen
Bijdragen aan dit onderwerp moeten vooral het proces beschrijven rond het bijdragen aan de PHP-handleiding, bijvoorbeeld uitleggen hoe pagina's moeten worden toegevoegd, hoe deze kunnen worden beoordeeld, gebieden vinden om bij te dragen, enzovoort.
Verbeter de officiële documentatie
PHP heeft al geweldige officiële documentatie op http://php.net/manual/ . De PHP Manual documenteert vrijwel alle taalfuncties, de kernbibliotheken en de meeste beschikbare extensies. Er zijn veel voorbeelden om van te leren. De PHP-handleiding is beschikbaar in meerdere talen en formaten.
Het beste van alles is dat iedereen de documentatie gratis kan bewerken .
Het PHP Documentation Team biedt een online editor voor de PHP Manual op https://edit.php.net . Het ondersteunt meerdere Single-Sign-On-services, inclusief inloggen met uw Stack Overflow-account. U kunt een inleiding tot de editor vinden op https://wiki.php.net/doc/editor .
Wijzigingen in de PHP-handleiding moeten worden goedgekeurd door mensen van het PHP Documentation Team met Doc Karma . Doc Karma lijkt een beetje op reputatie, maar is moeilijker te krijgen. Dit peer review-proces zorgt ervoor dat alleen feitelijk correcte informatie in de PHP-handleiding komt.
De PHP-handleiding is geschreven in DocBook, een gemakkelijk te leren opmaaktaal voor het schrijven van boeken. Het lijkt op het eerste gezicht misschien een beetje ingewikkeld, maar er zijn sjablonen om je op weg te helpen. U hoeft beslist geen DocBook-expert te zijn om een bijdrage te leveren.
Tips voor het bijdragen aan de handleiding
Hierna volgt een lijst met tips voor diegenen die willen bijdragen aan de PHP-handleiding:
- Volg de stijlrichtlijnen van de handleiding . Zorg ervoor dat de stijlrichtlijnen van de handleiding altijd worden gevolgd omwille van de consistentie.
- Voer spelling- en grammaticacontroles uit . Zorg ervoor dat de juiste spelling en grammatica wordt gebruikt - anders is de gepresenteerde informatie moeilijker te verwerken en ziet de inhoud er minder professioneel uit.
- Wees beknopt in uitleg . Voorkom dat u de informatie duidelijk en beknopt presenteert aan ontwikkelaars die ernaar willen verwijzen.
- Scheid code van zijn output . Dit geeft schonere en minder ingewikkelde codevoorbeelden die ontwikkelaars kunnen verwerken.
- Controleer de volgorde van de paginasecties . Zorg ervoor dat alle delen van de handmatige pagina die wordt bewerkt in de juiste volgorde staan. Uniformiteit in de handleiding maakt het gemakkelijker om informatie snel te lezen en op te zoeken.
- Verwijder PHP 4-gerelateerde inhoud . Specifieke vermeldingen voor PHP 4 zijn niet langer relevant, gezien hoe oud het nu is. Vermeldingen ervan moeten uit de handleiding worden verwijderd om te voorkomen dat deze met onnodige informatie wordt ingewikkeld.
- Juiste versiebestanden . Zorg er bij het maken van nieuwe bestanden in de documentatie voor dat de revisie-ID van het bestand als volgt op niets is ingesteld:
<!-- $Revision$ -->. - Nuttige opmerkingen samenvoegen in de handleiding . Sommige opmerkingen dragen nuttige informatie bij waarvan de handleiding zou kunnen profiteren. Deze moeten worden samengevoegd met de inhoud van de hoofdpagina.
- Breek de documentatie-build niet . Zorg er altijd voor dat de PHP-handleiding correct is opgebouwd voordat u de wijzigingen doorvoert.