Guidelines for Editing the Wiki

Wiki は ros パッケージ、スタックとアプリケーションをドキュメント化する有用な場所です。しかしながら、 Wiki を組織的に、そして最新にしておくことは重要です。 最低限の組織化なしで Wiki を維持することは難しいです。 そこで、ここに Wiki をよく組織化されるようにしておくためのいくつかの一般的なベストプラクティスがあります。

ROS

• ROS 名前空間（例えば、"ros.org/wiki/ROS/mynewpage") は特別です. あなたが特に ROS の一部をドキュメント化していないなら、この名前空間に文書を入れないでください。 この名前空間の文書はユーザーマニュアルの一部でしょう。

ROS and ROS-PKG

• もしあなたが新しいスタックあるいはパッケージページを作成する必要があるなら、どうか、ページを作成するとき、テンプレート（PackageTemplate と StackTemplate）を使ってください。

• もしあなたがスタックあるいはパッケージに対してレビューを作成する必要があるなら、どうか、ページを作成するとき、テンプレートコードと API レビューテンプレートを使ってください。
• パッケージあるいはスタック名がリポジトリと同じであることを確認してください。 もしあなたのパッケージネームが blue_goo であるなら、パッケージ文書は"wiki/blue_goo"におかれるべきです。

• もしパッケージあるいはスタックのための利用法文書がメインページを超えて広がるなら、どうかそれらのページをスタックあるいはパッケージの namespace （例えば rviz / DisplayTypes 、 rviz / UserGuide）内に置いてください。

• 命名規則を追跡するあなたのスタックに関係があるチュートリアルを作成するために、スタックページの一番下の"create a tutorial”リンクを使ってください。
• パッケージはすべて、スタックと結び付けられるパッケージをリストするトップにメニューを持っています。 Menus/stack_name でそれらを編集することを遠慮なくしてください、しかしどうかフォーマットを整合性があるようにしておこうとしてください。