Documentation Example Template

français

• one line description/intro.

Table of Contents Overview Purpose Rationale Implementation Parameters/Options First Parameter/Option Second Parameter ... Parameter Development Known Issues Future Version History Related Pages References

Overview

• multi-line/paragraph description.

Purpose

• what is the purpose of this plug-in

Rationale

• why does it work the way it does?
• why is it necessary?
• when should we use it?
• when should we not use it?

Implementation

• how does a user implement this
• link to basic working example

Parameters/Options

• one line intro

First Parameter/Option

• description of parameter
  • range of excepted values
  • properties
  • when do we use this parameter
  • etc.
• link to working example using parameter

Second Parameter

... Parameter

Development

• what do developers need to know?

Known Issues

• list any known issues with the project here, and a reason for when this will be resolved or why it will not be

Future

• what are the plans for this?
  • proposed changes
  • whats under-development
  • etc...

Version History

• description
• link to project commit descriptions

Related Pages

• list of other pages inside wiki that are related to this article

References

• list of external links relevant to this article