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.

+

+

= RMF Documentation =

+

+

The RMF documentation is maintained in the Eclipse Wiki. There are some special sections which are automatically included to an Eclipse Help plugin which is delivered with the RMF release. More information can be found in the [[#Wiki to Eclipse Help Generator]] chapter. Furthermore, some parts of the documentation are maintained in ReqIF files. This will allow us to specify nontrivial features (i.e. those too big for a Bugzilla entry) using ProR. These can then be linked to from the Wiki. The procedure is described in the [[#ReqIF to HTML Generator]] chapter.

+

+

== Wiki to Eclipse Help Generator ==

+

+

== ReqIF to HTML Generator ==

= Problem Description =

= Problem Description =

Revision as of 07:36, 12 June 2012

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

RMF Documentation

The RMF documentation is maintained in the Eclipse Wiki. There are some special sections which are automatically included to an Eclipse Help plugin which is delivered with the RMF release. More information can be found in the #Wiki to Eclipse Help Generator chapter. Furthermore, some parts of the documentation are maintained in ReqIF files. This will allow us to specify nontrivial features (i.e. those too big for a Bugzilla entry) using ProR. These can then be linked to from the Wiki. The procedure is described in the #ReqIF to HTML Generator chapter.

Wiki to Eclipse Help Generator

ReqIF to HTML Generator

Problem Description

Specification

Mind Map

Requirements

The initial requirements for the RMF documentation:

The following classes of documentation exist:

Developer Documentation for developers using RMF

User Documentation for ProR

Committer Documentation for developers contributing to RMF

Requirements Documentation in general

The documentation shall support cross referencing

The documentation shall be printable

The old ProR documentation (from pror.org) shall be recycled and adapted

Where it makes sense, the documentation should use RMF itself ("eat your own dogfood")

It is possible to manage ReqIF files in git and to generate HTML on checkin by Jenkins. Obviously, that does not make sense for all documentation.

Where it makes sense, documentation should be generated

i.e. for developer and committer documentation, it may sense to document in JavaDoc and to provide links to the generated JavaDoc HTML

Requirements for User Documentation

A user should be able to easily contribute to the user documentation (not limited to Committers)