PHP
Contribuire al manuale PHP
Ricerca…
introduzione
Il manuale PHP fornisce sia un riferimento funzionale che un riferimento al linguaggio insieme alle spiegazioni delle principali funzionalità di PHP. Il manuale PHP, a differenza della documentazione della maggior parte delle lingue, incoraggia gli sviluppatori PHP ad aggiungere i propri esempi e note a ciascuna pagina della documentazione. Questo argomento spiega il contributo al manuale PHP, insieme a suggerimenti, trucchi e linee guida per le migliori pratiche.
Osservazioni
I contributi a questo argomento dovrebbero principalmente delineare il processo intorno al contributo al Manuale PHP, ad esempio spiegare come aggiungere pagine, come inviarle per la revisione, trovare aree per contribuire ai contenuti, e così via.
Migliora la documentazione ufficiale
PHP ha un'ottima documentazione ufficiale già su http://php.net/manual/ . Il manuale PHP documenta praticamente tutte le funzionalità linguistiche, le librerie principali e le estensioni più disponibili. Ci sono molti esempi da cui imparare. Il manuale PHP è disponibile in più lingue e formati.
Meglio di tutti, la documentazione è gratuita per chiunque di modificare .
Il PHP Documentation Team fornisce un editor online per il manuale PHP su https://edit.php.net . Supporta più servizi Single-Sign-On, incluso l'accesso con l'account Stack Overflow. Puoi trovare un'introduzione all'editor su https://wiki.php.net/doc/editor .
Le modifiche al manuale di PHP devono essere approvate da persone del team di documentazione di PHP con Doc Karma . Doc Karma è un po 'come la reputazione, ma è più difficile da ottenere. Questo processo di revisione tra pari fa sì che solo le informazioni effettivamente corrette vengano inserite nel manuale PHP.
Il manuale PHP è scritto in DocBook, che è un linguaggio di marcatura facile da imparare per la creazione di libri. Potrebbe sembrare un po 'complicato a prima vista, ma ci sono modelli per iniziare. Sicuramente non è necessario essere un esperto di DocBook per contribuire.
Suggerimenti per contribuire al manuale
Di seguito è riportato un elenco di suggerimenti per coloro che desiderano contribuire al manuale PHP:
- Segui le linee guida sullo stile del manuale . Assicurati che le linee guida di stile del manuale vengano sempre seguite per motivi di coerenza.
- Eseguire controlli ortografici e grammaticali . Assicurati che l'ortografia e la grammatica siano corrette, altrimenti le informazioni presentate potrebbero essere più difficili da assimilare e il contenuto sembrerà meno professionale.
- Sii conciso nelle spiegazioni . Evita vaganti per presentare in modo chiaro e conciso le informazioni agli sviluppatori che stanno cercando di farne rapidamente riferimento.
- Codice separato dal suo output Ciò fornisce agli esempi di codice più chiari e meno complicati da digerire per gli sviluppatori.
- Controlla l'ordine della sezione della pagina . Assicurarsi che tutte le sezioni della pagina man in corso di modifica siano nell'ordine corretto. L'uniformità nel manuale facilita la lettura e la ricerca rapida delle informazioni.
- Rimuovi il contenuto relativo a PHP 4 . Le menzioni specifiche su PHP 4 non sono più rilevanti considerando quanti anni hanno. Le menzioni di esso dovrebbero essere rimosse dal manuale per impedirne la convalida con informazioni non necessarie.
- Correttamente i file di versione . Quando crei nuovi file nella documentazione, assicurati che l'ID revisione del file non sia impostato su nulla, in questo modo:
<!-- $Revision$ -->. - Unisci commenti utili nel manuale . Alcuni commenti contribuiscono con informazioni utili che il manuale potrebbe trarre vantaggio dall'avere. Questi dovrebbero essere uniti nel contenuto della pagina principale.
- Non rompere la compilazione della documentazione . Assicurati sempre che il manuale PHP sia compilato correttamente prima di confermare le modifiche.