Difference between revisions of "RMF/Contributor Guide/Documentation Guideline"

From Eclipsepedia

< RMF
Jump to: navigation, search
Line 1: Line 1:
 
This page describes where, and in what form, documentation for the RMF project should be recorded.
 
This page describes where, and in what form, documentation for the RMF project should be recorded.
 +
 +
== Mind Map ==
  
 
[[Image:rmfdocu_mindmap.png]]
 
[[Image:rmfdocu_mindmap.png]]
 +
 +
== Requirements ==
  
 
== Developer Documentation ==
 
== Developer Documentation ==

Revision as of 11:13, 26 April 2012

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

Contents

Mind Map

Rmfdocu mindmap.png

Requirements

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.