ドキュメンテーション参加へのお誘いと Codex 会議室ブログ

WordPressの公式日本語ドキュメンテーションサイトである Codex は、WordPress プロジェクト同様ボランティア貢献者の手によって運営・更新が行われています。アカウントは誰でも取得でき、Wiki 形式でいつでも更新ができます。

このたび、編集ボランティアの話し合いの場として試用していたWordPress Codex 日本語版 会議室ブログを正式公開しましたのでお知らせします。

「WordPress Codex 日本語版 会議室」ブログ

コア開発者が話し合いをする WordPress Development Updates や、インターフェースチームのブログ Make WordPress UI Blog などの日本語ドキュメンテーション版と思ってもらえるとわかりやすいかと思います。ドキュメンテーションに積極的に参加したいという方は、メンバーとして登録サイドバーからメール購読もできますので、興味のある方は登録してみてください。

Wiki のアカウントは取ってみたものの、何をしていいのかよく分からない…と言う方もいるかもしれません。そういう場合は、コミュニティ・ポータルページや以下のリストを参考にしてみてください。

また、ドキュメンテーション向けに以下の情報やアイディアもフォーラムにて募集しています。

その他ここには書ききれないくらいたくさん参加の機会やヘルプが必要なエリアがあります。分からないことがあれば、Codex 上はもちろん、フォーラムなどで声を聞かせてください。

プラグインの改善 – 変更履歴

以下は、2009年7月21日に書かれた WordPress.org 公式ブログの記事、「Improving your plugin – Changelogs」を訳したものです。本文内のリンク先はすべて英語ページです。


プラグイン作者とユーザーとの間で、新しいバージョンのプラグインにどういった変更があったのかがよりうまく伝わるようにするため、最近変更をいくつか行いました

私たちは、すべてのソフトウェアにはバージョンごとになにが変わったのか、概要を説明する更新履歴 (changelog) が同梱されているべきだと感じています。そうすることによってユーザーの皆さんが「いつアップグレードをしたら良いのか」、「どれくらいサイト上でのテストが必要なのか」といったことについて、状況を理解した上で判断を下せるからです。

簡単にこれを行い、コミュニケーションの方法をオープンにするため、プラグインの readme.txt ファイルに変更履歴セクションへの対応を追加しました。この変更履歴情報は、プラグインディレクトリのタブメニューに追加されるとともに、皆さんの WordPress の管理画面で新バージョンのプラグインに関する情報を表示するときにも見ることができます。

新しいセクションの形式は以下の通りです。

== Changelog ==

= 1.0 =
* A change since the previous version.
* Another change.

= 0.5 =
* List versions from most recent at top to oldest at bottom.

さらに、Subversion レポジトリへプラグインのファイルをコミットするときに、意味のあるログメッセージを追加することもおすすめしたいと思います。こうすることで、あなたのプラグインの変更点をさらに詳しく調べたい人が、その理由を理解することができるからです (現在のところ、多くのプラグイン作者がコミットコメントを空にしていますが、これでは役に立ちません)。