RMF/Contributor Guide/Documentation Guideline

This page describes where, and in what form, documentation for the RMF project should be recorded.

Mind Map

Requirements

The initial requirements for the RMF documentation:

• A user should be able to easily contribute to the documentation
• The documentation shall exists as eclipse wiki
• The documentation shall existis as eclipse help plugin
• The RMF documentation shall contain a documentation for developer
  • The developer documentation shall contain a tutorial for creating presentation plugins
  • The developer documentation shall contain an architecture description
  • The developer documentation shall support cross referencing
• The RMF documentation shall contain a documentation for users
  • The user documentation shall contain a tutorial for ProR
  • The user documentation shall contain a FAQ
  • The user documentation shall contain a reference
  • The user documentation shall support cross referencing
  • The user documentation shall contain documentation for custom presentation plugins
• The RMF documentation shall contain a roadmap
• The old ProR documentation (from pror.org) shall be recycled and adapted

Developer Documentation

Developer documentation resides in the Wiki. Important: Always include the RMF category at the end of all RMF pages:

[[Category:RMF]]

End User Documentation

User documentation currently resides at pror.org. It will be migrated eventually, although it is not clear yet where to. Please propose suggestions to the rmf-dev mailing list.