PHP
Внесение изменений в Руководство по PHP
Поиск…
Вступление
Руководство PHP предоставляет как функциональную ссылку, так и ссылку на язык наряду с объяснениями основных функций PHP. Руководство PHP, в отличие от документации большинства языков, побуждает разработчиков PHP добавлять свои собственные примеры и примечания на каждую страницу документации. В этом разделе объясняется вклад в руководство PHP, а также советы, рекомендации и рекомендации для лучшей практики.
замечания
Вклад в эту тему должен в основном описывать процесс, связанный с внесением вклада в Руководство по PHP, например, объяснять, как добавлять страницы, как отправлять их на рассмотрение, находить области для внесения контента и т. Д.
Совершенствовать официальную документацию
PHP имеет большую официальную документацию уже на http://php.net/manual/ . Руководство PHP содержит практически все функции языка, основные библиотеки и большинство доступных расширений. Есть много примеров, чтобы учиться. Руководство PHP доступно на нескольких языках и в форматах.
Лучше всего, документация бесплатна для редактирования .
Команда документации PHP предоставляет онлайн-редактор для руководства PHP на странице https://edit.php.net . Он поддерживает несколько служб Single-Sign-On, включая вход в систему с вашей учетной записью стека переполнения. Вы можете найти введение в редактор по адресу https://wiki.php.net/doc/editor .
Изменения в руководстве PHP должны быть одобрены людьми из группы документации PHP, имеющей Doc Karma . Doc Karma похожа на репутацию, но сложнее получить. Этот процесс экспертной оценки гарантирует, что в Руководство по PHP попадет только фактическая правильная информация.
Руководство по PHP написано в DocBook, которое является простым в изучении языка разметки для создания книг. На первый взгляд это может показаться немного сложным, но есть шаблоны, чтобы вы начали. Вы, конечно, не должны быть экспертом DocBook, чтобы внести свой вклад.
Советы по внесению вклада в руководство
Ниже приведен список советов для тех, кто хочет внести свой вклад в руководство по PHP:
- Следуйте указаниям стиля руководства . Убедитесь, что руководство по стилю руководства всегда соблюдается для согласованности.
- Выполнять орфографические и грамматические проверки . Обеспечьте правильное использование орфографии и грамматики - иначе представленная информация может быть сложнее ассимилироваться, а контент будет выглядеть менее профессионально.
- Будьте осторожны в объяснениях . Избегайте рассмешения, чтобы четко и кратко представить информацию разработчикам, которые хотят быстро ссылаться на нее.
- Отделите код от его выхода . Это дает более чистые и менее сложные примеры кода для разработчиков для переваривания.
- Проверьте порядок раздела страницы . Убедитесь, что все разделы редактируемой страницы руководства находятся в правильном порядке. Однородность в руководстве облегчает быстрый поиск и поиск информации.
- Удалите содержимое, связанное с PHP 4 . Конкретные упоминания о PHP 4 больше не актуальны, учитывая, сколько лет оно сейчас. Их следует удалить из руководства, чтобы избежать свертывания его ненужной информацией.
- Правильно файлы версий . При создании новых файлов в документации убедитесь, что идентификатор версии файла не установлен, например:
<!-- $Revision$ -->. - Объедините полезные комментарии в руководстве . Некоторые комментарии дают полезную информацию, которую руководство может извлечь из этого. Они должны быть объединены в содержимое главной страницы.
- Не нарушайте сборку документации . Всегда проверяйте правильность написания PHP-кода, прежде чем вносить изменения.