menu
Logo
  • Why azing?
  • Blog
  • Help
ENarrow_drop_down
  • DE
  • EN
Suche in Checklisten
search
azing Logo ENarrow_drop_down
  • DE
  • EN
  • Why azing?
  • Help
azing
drive_folder_upload
  • homeChecklist Templates
  • south

folder_sharedRecipes - Best Practices and Principles

  • homeChecklist Templates
  • south

folder_sharedRecipes - Best Practices and Principles

Folders and checklists

  • infoInput Fields and Code
  • infoPrinciple: Click-Click Instructions should be Reference Material
  • infoPrinciple: DRY (Don't Repeat Yourself)
  • infoPrinciple: Re-Use the Wheel (don't Reinvent or Redocument)
  • infoPrinciple: SoC - Separation of Concerns for Recipe, Reference and Template
  • check_circletesting

Parts (0) expand_more

These are small document-parts which are used in other documents. They are not a starting point for any real activity. Because of this, they will be listed further down and the search will not list them unless requested. 

As soon as you start to copy/paste certain instructions from one recipe to another, you're probably doing something wrong. 

Examples

  1. You might have a few recipes which describe working on a website - and you're giving login instructions in each recipe. 
  2. You are creating recipes for working with a software (Microsoft Word, your ERP, etc.) and you have the same instructions for getting to a special dialog which you are repeating. 
  3. You are describing various processes to clean your office, and you have "get ready" steps in each recipe

Problems with Repeating Yourself

As soon as you repeat yourself, you'll end up with various issues like

  1. your recipes get very big, to describe very trivial steps which most users can skip
  2. if ever this instruction changes, you will have to find all places where you used it, and make sure you update it (this usually ends up causing problems)

Solution

If you notice that you're repeating yourself - often using copy/paste - you should consider the following changes:

  1. Create a sub-recipe for only these steps. Even if it's just 1-2 steps, it's probably better in a sub-recipe
  2. Or better: create a reference-material / information describing this, because often it's nothing you need to click off, but just something the worker will look at
Logo
Legal | Content Copyright CC-BY 4.0
bug_reportReport Bug
  • info
  • Links
  • Permissions
code Share
code
URL copied to clipboard.
Embed Checklist close
Copy Copy
Content Copyright

CC-BY 4.0

Translations

None

azing

QR-Code
azing.org/azing/r/ueyvJiqk
View & Use

Public (can be used by everybody)

Edit & Admin

Professional (only select users)

Here you can see how this document is used and linked by other documents

Used in (0)

Others referencing this

Uses these (0)

Documents linked from this document

How it Behaves

How this document is categorized changes how it behaves.

This is a main document, it is listed normally and appears in search result.

Type

This is an Information. Lists are treated as information and not as checkboxes'

Get something to say?

Comment to start a discussion or make a note
send

please log on to chat

close

Durchsuche ganz Azing