PHP
Contribuyendo al Manual de PHP
Buscar..
Introducción
El Manual de PHP proporciona una referencia funcional y una referencia de idioma junto con explicaciones de las principales funciones de PHP. El Manual de PHP, a diferencia de la documentación de muchos idiomas, alienta a los desarrolladores de PHP a que agreguen sus propios ejemplos y notas a cada página de la documentación. Este tema explica la contribución al manual de PHP, junto con consejos, trucos y pautas para las mejores prácticas.
Observaciones
Las contribuciones a este tema deben describir principalmente el proceso alrededor de la contribución al Manual de PHP, p. Ej., Explicar cómo agregar páginas, cómo enviarlas para su revisión, buscar áreas para contribuir con contenido, etc.
Mejorar la documentación oficial.
PHP ya tiene una gran documentación oficial en http://php.net/manual/ . El Manual de PHP documenta prácticamente todas las características de idioma, las bibliotecas principales y las extensiones más disponibles. Hay muchos ejemplos para aprender. El Manual de PHP está disponible en múltiples idiomas y formatos.
Lo mejor de todo, la documentación es gratuita para que cualquiera pueda editarla .
El equipo de documentación de PHP proporciona un editor en línea para el Manual de PHP en https://edit.php.net . Admite múltiples servicios de inicio de sesión único, incluido el inicio de sesión con su cuenta de desbordamiento de pila. Puede encontrar una introducción al editor en https://wiki.php.net/doc/editor .
Los cambios en el Manual de PHP deben ser aprobados por personas del Equipo de Documentación de PHP que tenga Doc Karma . Doc Karma es algo así como reputación, pero más difícil de conseguir. Este proceso de revisión por pares se asegura de que solo la información correcta y objetiva entre en el Manual de PHP.
El Manual de PHP está escrito en DocBook, que es un lenguaje de marcado fácil de aprender para crear libros. Puede parecer un poco complicado a primera vista, pero hay plantillas para comenzar. Ciertamente no es necesario ser un experto en DocBook para contribuir.
Consejos para contribuir al manual.
La siguiente es una lista de consejos para aquellos que desean contribuir al manual de PHP:
- Siga las pautas de estilo del manual . Asegúrese de que las pautas de estilo del manual siempre se sigan por razones de coherencia.
- Realizar correcciones ortográficas y gramaticales . Asegúrese de que se esté utilizando la ortografía y la gramática adecuadas; de lo contrario, la información presentada puede ser más difícil de asimilar y el contenido se verá menos profesional.
- Ser terso en las explicaciones . Evite divagaciones para presentar de manera clara y concisa la información a los desarrolladores que buscan una referencia rápida.
- Código separado de su salida . Esto proporciona ejemplos de código más limpios y menos complejos para que los desarrolladores puedan digerirlos.
- Compruebe el orden de la sección de la página . Asegúrese de que todas las secciones de la página del manual que se está editando estén en el orden correcto. La uniformidad en el manual hace que sea más fácil leer y buscar información rápidamente.
- Quitar contenido relacionado con PHP 4 . Las menciones específicas a PHP 4 ya no son relevantes, dada la antigüedad que tiene. Las menciones del mismo deben eliminarse del manual para evitar que se convulsione con información innecesaria.
- Versión correcta de los archivos . Al crear nuevos archivos en la documentación, asegúrese de que el ID de revisión del archivo esté configurado en nada, así:
<!-- $Revision$ -->. - Fusionar comentarios útiles en el manual . Algunos comentarios aportan información útil que el manual podría beneficiarse de tener. Estos deben ser combinados en el contenido de la página principal.
- No rompas la compilación de documentación . Asegúrese siempre de que el manual de PHP se compile correctamente antes de confirmar los cambios.