PHP
PHPマニュアルへの貢献
サーチ…
前書き
PHP Manualは、PHPの主な機能の説明とともに、機能参照と言語リファレンスの両方を提供します。 PHPマニュアルは、ほとんどの言語のドキュメントとは異なり、PHP開発者に独自のサンプルと注釈をドキュメントの各ページに追加するよう奨励しています。このトピックでは、ベストプラクティスのヒント、トリック、ガイドラインとともに、PHPマニュアルへの寄稿について説明します。
備考
このトピックへの貢献は、主に、PHPマニュアルへの貢献に関するプロセスを概説します。例えば、ページの追加方法、レビューのための提出方法、コンテンツ寄稿の範囲の指定などです。
公式文書を改善する
PHPにはすでに公式のドキュメントがhttp://php.net/manual/にあります。 PHPマニュアルは、ほとんどすべての言語機能、コアライブラリ、および最も多く使用可能な拡張機能を文書化しています。学ぶべき例はたくさんあります。 PHP Manualは複数の言語とフォーマットで利用できます。
何よりも、ドキュメントは誰でも自由に編集できます 。
PHPドキュメンテーションチームは、 https://edit.php.netの PHPマニュアルのオンラインエディタを提供しています 。 Stack Overflowアカウントでのログインを含む、複数のシングルサインオンサービスをサポートしています。エディタの紹介はhttps://wiki.php.net/doc/editorで見つけることができます 。
PHPマニュアルの変更は、 Doc Karmaを持っているPHPドキュメントチームからの承認を受ける必要があります。 Doc Karmaは評判のようなものですが、入手するのは難しいです。このピアレビュープロセスは、事実上正しい情報だけがPHP Manualに入ることを保証します。
PHPマニュアルはDocBookで書かれています。これは、書籍を作成するための簡単なマークアップ言語です。一見すると少し複雑に見えるかもしれませんが、始めるためのテンプレートがあります。貢献するにはDocBookの専門家である必要はありません。
マニュアルに貢献するためのヒント
以下は、PHPマニュアルに貢献したい人のためのヒントのリストです：
- マニュアルのスタイルガイドラインに従ってください 。一貫性のためにマニュアルのスタイル・ガイドラインに常に従ってください 。
- スペルチェックと文法チェックを行います 。適切なスペルと文法が使用されていることを確認してください。そうでない場合、提示される情報がより同化しにくくなり、内容の専門性が低下します。
- 説明を簡潔にする 。情報をすばやく参照しようとする開発者に、情報をはっきりと簡潔に提示することを避けてください。
- 出力からコードを分離する 。これにより、よりクリーンで複雑なコード例が、開発者にダイジェストされます。
- ページセクションの順序を確認してください 。編集中のマニュアルページのすべてのセクションの順序が正しいことを確認してください。マニュアルの統一性により、迅速に情報を読み込んで参照することが容易になります。
- PHP 4関連のコンテンツを削除します 。 PHP 4の具体的な記述は、何歳になってももはや関係しません。不必要な情報でそれを畳み込まないようにするため、その説明をマニュアルから削除する必要があります。
- 適切なバージョンのファイル 。ドキュメントに新しいファイルを作成するときは、ファイルのリビジョンIDが
<!-- $Revision$ -->ように何も設定されていないことを確認してください。 - 便利なコメントをマニュアルにマージします 。いくつかのコメントは、マニュアルが有することから利益を得ることができる有益な情報を提供する。これらは、メインページのコンテンツにマージする必要があります。
- ドキュメントビルドを壊さないでください 。変更をコミットする前に、PHPマニュアルが正しく構築されていることを必ず確認してください。