How recipes work¶
Sections of a recipe¶
| Section | Content |
|---|---|
| Summary | The recipe in two or three sentences. |
| Steps | Numbered steps to follow. |
| How to check the output | Who or what checks the result, and how long it takes. |
| Examples | Examples from groups that use the recipe, with names and details removed. |
| Known problems | Errors seen so far, linked to What went wrong. |
| Skills | Skill briefs for the recipe, from the list of skills. |
| Related practices | The practices on aiforscience.eu that the recipe follows. |
| Change history | Dated changes, newest first. |
The box "About this recipe" shows the stage (prepare for agents, think with agents, or implement with agents), how the output is checked (machine-checkable, expert-checkable or hard to verify), and how much freedom the agent has.
Status¶
| Status | Meaning |
|---|---|
| draft | Proposed, but not yet in regular use by the contributor. |
| tried | In regular use by at least one group. |
| reproduced | Used by a second, independent group, which added its own example to the page. |
A recipe becomes reproduced only when another group adds an example. An error report can add a step to a recipe or change its status back.
Numbering¶
Recipe N follows point N of the Comment "Delegate what you can check" (see The idea). New recipes from contributors get the next free number.
Review¶
Proposals and changes are public, editors review them, and every change is dated. Names and details are removed from examples by default. Contributors are named only if they ask to be.