alguidelines/content/docs/Contributing/Templates/Patterns/index.md
2022-02-21 22:57:39 -08:00

1.5 KiB

title tags categories
Pattern Name
Pattern

Created by Described by

Abstract

Short, descriptive and easy to remember description of this pattern.

Context

Sets the stage where the pattern takes place. 1-2 sentences.

Problem

What happens before this pattern is used? How can it go wrong? 1-5 lines.

Description

In depth description on what this Pattern is all about

  • basic components
  • how the interact
  • steps to implement
  • considerations to take

Usage

If applicable: where is it used in an app. You can refer to any app, BaseApp, or a (public) ISV app.

Benefits

1-2 sentences: what did you just solve

When not to use

Usually, there are occasions where NOT to implement the pattern. List the disadvantages of this pattern here.

List of references

Youtube-link? BaseApp? Tweet? ...

Discussions

Please discuss this guideline

You can find discussions on all "Best Practices" here.