UserGuideTemplate

These are basic rules for RedDeer user guide (https://github.com/jboss-reddeer/reddeer/wiki/User-Guide)

General Rules

• from simple to complex
• example driven, for API specific there is javadoc
• for complete API there is javadoc
• use formatting, images
• well structured, API, Implementations,
• use code hightlight and blocks
• keep page short, if growing split it into more
• from basic and simpel usage to comples
• when done add link to userguide doc

Some Example of API usage how it can be structured

API / Abstract

• Interface / Abstract

Implementation(s)

• Impl1
• Impl2
• Impl3

Usage

Implementation

image

Lookup for ...."

// code

Operation1

// operation code

Short notation

// code

See example below, go from simple to more complex, add whatever details that are important, focus mainly on examples with comments

API / Abstract

• Button / AbstractButton

Implementation(s)

• PushButton
• CheckButton
• RadioButton

Usage

Implementation

image

Lookup for a button with text "Apply"

Button b = new PushButton("Apply");

Click a button

b.click(); 

Short notation

new PushButton("Apply").click();