Documentation Example Template - nschonni/wet-boew GitHub Wiki

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

• multi-line/paragraph description.

• what is the purpose of this plug-in

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

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

• one line intro

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

• what do developers need to know?

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

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

• description
• link to project commit descriptions

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

• list of external links relevant to this article