Versions Compared

Version Old Version 5 New Version 6
Changes made by

yeinyein

Nidahil Bashir

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Introduction

<Applet Logo>
To download this Applet, please go to the Applet Store. <provide Applet Store URL, so that user can click on it, and it will jump to the applet store in ​ and subsequently be able to “Add the applet to a catalog” (if they are owner and admin of certain catalog)?

Short description of what is the purpose of this applet.

Intended Users

e.g. The cashiers of a company, the branch managers, or which departments etc

Features and Functions

Use Cases

e.g. for Doc Item Maintenance applet

...

you can also use the Doc Item Maintenance as the central product repository, for syncing to various other systems.

Add Ons

For example, if there’s basic, standard, professional , enterprise edition etc… providing a table to describe the differences.

Basic Setup/Settings

 

Step-By-Step Guide on Menus

  3.  

Info

Highlight important information in a panel like this one. To do this, click on the + sign on top menu, select “Info Panel”. To edit this panel’s color or style, select one of the options in the menu below.

Related Applets:

This applet depends on:

This applet is depended by:

...

Alternative / Similar Applets / Variants:

Filter by label (Content by label)
showLabelsfalse
max5
spacescom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@3b70e30
sortmodified
showSpacefalse
reversetrue
typepage
cqllabel = "kb-how-to-article" and type = "page" and space = "AKAUN"
labelskb-how-to-article

Style Guide

  1. Headings
    - Use Heading 2 for titles.

  2. Table of Contents
    - Use macro “Table of Contents” from the top menu.

  3. Links
    - Use link text. For example: EcomSync Applet instead of https://wavelet.atlassian.net/wiki/spaces/AKAUN/pages/2944958608/EcomSync+Applet

  4. Labels
    - Add labels to categorize Applets by Modules (example: module-sales), or industry (example: industry-logistic).

  5. Images
    - Save images in png format before attaching.
    - Set image to align left (not centre).

  6. Sentences
    - Use short, clear, concise sentences.
    - Use active voice.
    (thumbs up) Recommended : Send a query to the service. The server sends an acknowledgment.
    (thumbs down) Not recommended : The service is queried, and an acknowledgment is sent.
    - Use standard English word order. Follow the subject + verb + object order.
    - Break sentences into bullet points if possible. If steps/order are involved, use numbering.
    - Be consistent. For example, if first letter in bullet points are capitalize, make sure they are standardized across all pages.

  7. Abbreviations
    - Always spell out the words and include abbreviations before using the abbreviations in a page.
    - For example: Border Gateway Protocol (BGP)