How to Write a Recipe
This section presents a concise summary of what the recipe will teach, focusing primarily on: (1) the outcome of the recipe (what are you trying to achieve, in non-technical terms); (2) the main technical approaches employed; and (3) whether the recipe is based on someone else’s work/code (they should be cited if so).
This section should be entirely bullet points; each bullet point is one required ingredient.
- Ingredients include technical and non-technical components (e.g. Python and a corpus).
- When the ingredients are specific files/code, there should be a hyperlink to them.
- If the work is based on someone else’s work/code, it should be included as an ingredient.
- The steps should be a series of paragraphs, describing the process of the recipe in easy-to-grasp language.
- The recipe should be broken into phases, with each phase having a heading and 1-3 paragraphs describing it.
- Highly technical language should be avoided.
- Code snippets should be avoided; create hyperlinks to the code elsewhere if necessary.
This area should be 1-3 paragraphs, noting:
- Any additional key concepts or considerations related to the recipe.
- Other text analysis tools related to the recipe.
- How the recipe could be used in the context of a larger research goal.
This area should be a set of bullet points, potentially including:
- Further exercises the user could complete.
- Ways to augment the recipe.
- A bullet point list of related online resources. Each one should be hyperlinked, and the creator of the resource noted.