e r l a n g : c o o k b o o k

/ Erlang.CreatingRecipes

This Web


WebHome 
WebChanges 
TOC
NewRecipe 
WebTopicList 
WebStatistics 

All Webs


Chicken
Cookbook
Erlang
Know
Main
Plugins
Sandbox
Scm
TWiki  

Erlang Links


Erlang.org
Erlang Wiki
ErlMan
Erlang Wiki
The Jungerl
Erlang-fr.org
Joe Armstrong
Lambda the Ultimate

Erlang Web Ring


[Prev]: Joe Armstrong's Page
[Next]: Joe Armstrong's Page

Creating Recipes

This page discusses both reasons for creating recipes and provides guidance on creating recipes. area.

How To Create Recipes

Use the NewRecipe page (accessible from the bar on the left in the VoidSkin) to quickly create a recipe using the standard template.

A recipe consists of five main sections:

  1. The problem definition concisely presents the problem
  2. The solution presents the preferred solution
  3. The discussion discusses tradeoffs inherent in the solution and other possible solutions
  4. See Also references other related recipes
  5. Comments are material that isn't directly relevant to the recipe. Often they discuss meta issues.

Note that sometimes there are two very different solutions, where neither is superior in the general case. In this case, both solutions should be documented in the Solution section.

Reasons For Creating Recipes

There are two main reasons for creating recipes:

See Also

AuthorGuide

Comments

CookbookForm
TopicType: Recipe
ParentTopic: AuthorRecipes
TopicOrder: 020

 
 
Copyright © 2004 by the contributing authors. All material on the Erlang Cookbook web site is the property of the contributing authors.
This material can be redistributed and/or modified under the terms of the GNU Lesser General Public License (LGPL), version 2.1, as published by the Free Software Foundation.
Ideas, requests, problems regarding Schematics Cookbook? Send feedback.
/ You are Main.guest