ROS Documentation Contest

| No Comments | No TrackBacks
While often neglected, documentation helps make your project usable, so here is a contest for making great documentation!

contest-pnf.png

Have you seen this page? Now there is a contest to fix it!

To provide some motivation for you to complete your project, I Heart Robotics and Willow Garage have teamed up for the ROS Documentation Contest.

contest-prizes.jpg

We have prizes of official ROS Diamondback and I Heart Robotics T-Shirts available for the best new documentation. Tell us how your code works and you could win both shirts!

How to Enter
To enter, add your documentation to the ROS.org wiki and email contest@iheartrobotics.com with a link to your recently updated documentation.

Rules
  • All entries must be documented on the ROS.org wiki and the documentation must be licensed under Creative Commons Attribution 3.0.
  • Integrated API Documentation must be open source using an OSI-approved license and be hosted on a publicly accessible server.
  • Entries must for open source packages that work directly with ROS.
  • Videos must be Creative Commons licensed and embeddable on the ROS.org and I Heart Robotics blogs.
  • You may enter as many entries as you like and as early as you like.

Deadline
Prizes will be awarded on a rolling basis until supplies are exhausted. The first winners will be announced within the next 30 days, subsequent winners will be announced at least once every 30 days until the end of the contest.

Eligibility
Contributors from most countries are eligible where ever legally and financially possible. You can quickly check if you can receive shipments via US Postal Service Flat Rate Priority Mail International or can email questions to contest@iheartrobotics.com.

Judging Criteria
  • Package documentation
  • Description
  • Examples
  • Installation
  • Topics / Services
  • Parameters 
  • Videos
  • Pictures
  • Tutorials
  • API documentation
Since this contest is designed to motivate contributors to document their code, only documentation with significant improvements after March 27th will be considered. For equally well-documented projects, priority will be given to which ever is more useful.

More information can be found at the ROS Documentation Contest page.

No TrackBacks

TrackBack URL: http://www.ros.org/mt-tb.cgi/359

Leave a comment

About this Entry

This page contains a single entry by I Heart Robotics published on March 27, 2011 1:14 PM.

OpenRAVE IKFast Robot Database Released was the previous entry in this blog.

PointClouds.org: A new home for Point Cloud Library (PCL) is the next entry in this blog.

Find recent content on the main index or look in the archives to find all content.


Please submit content to be reviewed by emailing ros-news@googlegroups.com.