Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
43 lines (23 sloc) 2.37 KB
title type order
Introduction
cookbook
0

WORK IN PROGRESS

This cookbook is still in its very early stages. At this point, we will not be linking to it from anywhere else. Pages may be removed or reorganized at any time. Even the goals and overall format are still in flux.

The Cookbook vs the Guide

How is the cookbook different from the guide? Why is this necessary?

  • Greater Focus: In the guide, we're essentially telling a story. Each section builds on and assumes knowledge from each previous section. In the cookbook, each recipe can and should stand on its own. This means recipes can focus on one specific aspect of Vue, rather than having to give a general overview.

  • Greater Depth: To avoid making the guide too long, we try to include only the simplest possible examples to help you understand each feature. Then we move on. In the cookbook, we can include more complex examples, combining features in interesting ways. Each recipe can also be as long and detailed as it needs to be, in order to fully explore its niche.

  • Teaching JavaScript: In the guide, we assume at least intermediate familiarity with ES5 JavaScript. For example, we won't explain how Array.prototype.filter works in a computed property that filters a list. In the cookbook however, essential JavaScript features (including ES6/2015+) can be explored and explained in the context of how they help us build better Vue applications.

  • Exploring the Ecosystem: For advanced features, we assume some ecosystem knowledge. For example, if you want to use single-file components in Webpack, we don't explain how to configure the non-Vue parts of the Webpack config. In the cookbook, we have the space to explore these ecosystem libraries in more depth - at least to the extent that is universally useful for Vue developers.

Guidelines for Recipes

Recipes should generally:

  1. Solve a specific, common problem
  1. Start with the simplest possible example
  1. Introduce complexities one at a time
  1. Link to other docs, rather than re-explaining concepts
  1. Describe the problem, rather than assuming familiarity
  1. Explain the process, rather than just the end result
  1. Explain the pros and cons of your strategy, including when it is and isn't appropriate
  1. Mention alternative solutions, if relevant, but leave in-depth explorations to a separate recipe
You can’t perform that action at this time.