Skip to content

Commit 4c9e755

Browse files
committed
Review on cookbook/index
1 parent 163d204 commit 4c9e755

File tree

1 file changed

+29
-29
lines changed

1 file changed

+29
-29
lines changed

src/cookbook/index.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,77 @@
11
# Introdução
22

3-
## O livro de receitas x o guia
3+
## Livro de Receitas vs. Guia
44

5-
Como o livro de receitas é diferente do guia? Por que é necessário?
5+
Como o livro de receitas é diferente do guia? Por que ele é necessário?
66

7-
- **Maior Foco**: Neste guia, estamos essencialmente contando uma história. Cada seção se desenvolve e assume o conhecimento de cada seção anterior. No livro de receitas, cada receita pode e deve se manter por si própria. Isto significa que receitas podem focar em um aspecto específico do Vue, ao invés de precisar fornecer uma visão geral.
7+
- **Maior Foco**: No guia, estamos essencialmente contando uma história. Cada seção se desenvolve e assume o conhecimento da seção anterior. No livro de receitas, cada receita pode e deve ser independente. Isso significa que receitas podem focar em um aspecto específico do Vue, ao invés de precisar fornecer uma visão geral.
88

9-
- **Maior Profundidade**: Para evitar tornar este guia muito longo, decidimos incluir apenas os exemplos mais simples possíveis para ajudar você a entender cada funcionalidade. E aí, seguimos. No livro de receitas podemos incluir exemplos mais complexos, combinando funcionalidades de maneiras interessantes. Cada receita pode também ser tão longa e detalhada quanto necessário, a fim de explorar totalmente o seu nicho.
9+
- **Maior Profundidade**: Para evitar tornar o guia muito longo, decidimos incluir apenas os exemplos mais simples possíveis para ajudar você a entender cada recurso. Então seguimos em frente. No livro de receitas podemos incluir exemplos mais complexos, combinando recursos de maneiras interessantes. Cada receita pode também ser tão longa e detalhada quanto necessário, a fim de explorar totalmente o seu nicho.
1010

11-
- **Ensinando JavaScript**: Neste guia, assumimos pelo menos familiaridade intermediária com JavaScript ES5. Por exemplo, não explicaremos como o `Array.prototype.filter` funciona em uma propriedade computada que filtra uma lista. No livro de receitas, entretanto, funcionalidades essenciais do JavaScript (incluindo ES6/2015+) podem ser exploradas e explicadas no contexto de como elas nos ajudam a construir melhores aplicações Vue.
11+
- **Ensinando JavaScript**: No guia, assumimos pelo menos familiaridade intermediária com JavaScript ES5. Por exemplo, não explicaremos como o `Array.prototype.filter` funciona em um dado computado que filtra uma lista. No livro de receitas, entretanto, recursos essenciais do JavaScript (incluindo ES6/2015+) podem ser exploradas e explicadas no contexto de como elas nos ajudam a construir aplicações Vue melhores.
1212

13-
- **Explorando o Ecossistema**: Para funcionalidades avançadas, assumimos algum conhecimento do ecossistema. Por exemplo, se você quer utilizar Componentes _Single-File_ no Webpack, não explicaremos como configurar as partes que não do Vue nas definições do Webpack. No livro de receitas, temos espaço para explorar o ecossistema de bibliotecas mais a fundo - ao menos até o ponto onde seja universalmente útil para desenvolvedores Vue.
13+
- **Explorando o Ecossistema**: Para recursos avançados, assumimos algum conhecimento do ecossistema. Por exemplo, se você quer utilizar Componentes Single-File no Webpack, não explicaremos como configurar as partes que não são do Vue nas definições do Webpack. No livro de receitas, temos espaço para explorar o ecossistema de bibliotecas mais a fundo - ao menos até o ponto onde seja universalmente útil para desenvolvedores Vue.
1414

15-
::: tip
15+
::: tip Nota
1616
Com todas essas diferenças, por favor, observe que o livro de receitas ainda _não_ é um manual passo-a-passo. É esperado que você tenha conhecimento básico de habilidades como HTML, CSS, JavaScript, npm/yarn pela maior parte do seu conteúdo.
1717
:::
1818

19-
## Contribuições para o Livro de receitas
19+
## Contribuições para o Livro de Receitas
2020

2121
### O que estamos buscando
2222

23-
O Livro de receitas dá exemplos aos desenvolvedores que cobrem desde casos comuns até casos de uso interessantes, e que também explicam detalhes mais complexos progressivamente. Nosso objetivo é ir além de um simples exemplo introdutório, e demonstrar conceitos que podem ser aplicáveis de maneira ampla, assim como ressalvas para essas abordagens.
23+
O Livro de Receitas dá exemplos aos desenvolvedores que cobrem desde casos comuns até casos de uso interessantes, e que também explicam detalhes mais complexos progressivamente. Nosso objetivo é ir além de um simples exemplo introdutório, e demonstrar conceitos que podem ser aplicáveis de maneira ampla, assim como ressalvas para essas abordagens.
2424

25-
Se você está interessado em contribuir, por favor, inicie uma colaboração preenchendo uma _issue_ com a _tag_ **cookbook idea** com o seu conceito para que possamos ajudá-lo a realizar o _pull request_ com sucesso. Depois que sua ideia for aprovada, por favor, siga o modelo abaixo conforme possível. Algumas seções são exigidas, e algumas são opcionais. Seguir a ordem numérica é recomendado fortemente, mas não obrigatório.
25+
Se você está interessado em contribuir, por favor, inicie uma colaboração preenchendo uma _issue_ com a _tag_ **cookbook idea** com o seu conceito para que possamos ajudá-lo a realizar o _pull request_ com sucesso. Depois que sua ideia for aprovada, por favor, siga o modelo abaixo conforme possível. Algumas seções são exigidas, e algumas são opcionais. Seguir a ordem numérica é fortemente recomendado, mas não obrigatório.
2626

2727
Receitas geralmente devem:
2828

2929
- Resolver um problema comum e específico
3030
- Começar com o exemplo mais simples possível
3131
- Introduzir uma complexidade por vez
32-
- Ligar outros documentos, ao invés de reexplicar conceitos
32+
- Referenciar outros documentos, ao invés de reexplicar conceitos
3333
- Descrever o problema, ao invés de assumir familiaridade
34-
- Explicar o processo, ao invés apenas o resultado final
35-
- Explicar os prós e contras de sua estratégia, incluindo quando ela é e não é adequada
34+
- Explicar o processo, ao invés de apenas o resultado final
35+
- Explicar os prós e contras de sua estratégia, incluindo quando ela é ou não adequada
3636
- Mencionar soluções alternativas, se relevante, mas deixar explorações a fundo para outra receita
3737

38-
Pedimos que você siga o modelo abaixo. Queremos entender, entretanto, que pode haver situações em que você deve necessariamente desviar pela claridade ou pelo fluxo. De Qualquer maneira, todas as receitas devem em algum ponto discutir a nuance da sua decisão feita usando esse padrão, preferencialmente no formulário da seção de padrões alternativos.
38+
Pedimos que você siga o modelo abaixo. No entanto, entendemos que pode haver situações em que você deve necessariamente desviar pela claridade ou fluxo. De qualquer maneira, todas as receitas devem em algum ponto discutir a nuance da decisão feita usando esse padrão, preferencialmente no formato da seção de padrões alternativos.
3939

40-
### Exemplo base <Badge text="required" type="error" />
40+
### Exemplo Base <Badge text="required" type="error" />
4141

4242
1. Articule o problema em uma frase ou duas.
43-
2. Explica a solução mais simples possível em uma frase ou duas.
43+
2. Explique a solução mais simples possível em uma frase ou duas.
4444
3. Mostre um pequeno exemplo de código.
45-
4. Explique o que ele realiza em uma frase.
45+
4. Explique o que ele faz em uma frase.
4646

4747
### Detalhes sobre o Valor <Badge text="required" type="error" />
4848

49-
1. Aborde perguntas comuns que podem surgir enquanto se olha o exemplo. (Blockquotes são ótimos para isso)
49+
1. Aborde perguntas comuns que podem surgir enquanto se olha o exemplo. (Blocos de citações são ótimos para isso)
5050
2. Dê exemplos de erros comuns e como eles podem ser evitados.
5151
3. Mostre exemplos de código muito simples sobre bons e maus padrões.
5252
4. Debata sobre o porquê este possa ser um padrão contundente. Links para referência não são exigidos, mas são encorajados.
5353

54-
### Exemplo de caso real <Badge text="required" type="error" />
54+
### Exemplo do Mundo Real <Badge text="required" type="error" />
5555

56-
Demonstre o código que empoderaria um caso de uso comum ou interessante, seja por:
56+
Demonstre o código que resolveria um caso de uso comum ou interessante, seja por:
5757

58-
1. Num guia passo-a-passo por alguns exemplos curtos, ou
59-
2. Embutindo um exemplo no codepen/jsfiddle
58+
1. Percorrendo alguns exemplos concisos de configuração, ou
59+
2. Embutindo um exemplo do codepen/jsfiddle
6060

61-
Se você escolher fazer o último, você ainda deve falar sobre ele é e o que faz.
61+
Se você escolher fazer o último, ainda deve falar sobre o que ele é e faz.
6262

6363
### Contexto Adicional <Badge text="optional" />
6464

65-
É extremamente útil escrever um pouco sobre tal padrão, ou onde mais se aplicaria, porque funciona bem, e passar um pouco de código conforme você explica, ou forneça materiais de leitura para as pessoas.
65+
É extremamente útil escrever um pouco sobre tal padrão, ou onde mais se aplicaria, por que funciona bem, e passar um pouco de código conforme você explica ou fornece materiais de leitura para as pessoas.
6666

67-
### Quando evitar este padrão <Badge text="optional" />
67+
### Quando Evitar Este Padrão <Badge text="optional" />
6868

69-
Esta seção não é obrigatória, mas altamente recomendada. Não fará sentido escrevê-la por algo tão simples como acionar classes baseadas em mudança de estado, mas para padrões mais avançados como mixins é vital. A resposta para a maioria das questões de desenvolvimento é ["Depende!"] (https://codepen.io/rachsmith/pen/YweZbG), esta seção aborda isso. Aqui, faremos uma análise sincera sobre quando o padrão é útil e sobre quando ele deve ser evitado, ou quando outra coisa fizer mais sentido.
69+
Esta seção não é obrigatória, mas altamente recomendada. Não fará sentido escrevê-la por algo tão simples como alternar classes baseado em mudança de estado, mas para padrões mais avançados como _mixins_ é vital. A resposta para a maioria das questões de desenvolvimento é ["Depende!"](https://codepen.io/rachsmith/pen/YweZbG), esta seção aborda isso. Aqui, faremos uma análise sincera sobre quando o padrão é útil e sobre quando ele deve ser evitado, ou quando outra coisa fizer mais sentido.
7070

71-
### Padrões alternativos <Badge text="required with avoidance section" type="warning" />
71+
### Padrões Alternativos <Badge text="required with avoidance section" type="warning" />
7272

73-
Esta seção é exigida quando você forneceu a seção acima sobre prevenção. É importante explorar outros métodos para que as pessoas que ouviram que algo é um antipadrão em certas situações não fiquem só imaginando. Ao fazer isso, considere que a web é uma grande tenda e que muitas pessoas possuem estruturas diferentes de código-base e que estão resolvendo problemas diferentes. O aplicativo é grande ou pequeno? Eles integrarão o Vue em um projeto existente, ou irão construir do zero? Seus usuários estão tentando alcançar uma finalidade ou muitas? Há muitos dados assíncronos? Todas estas considerações irão impactar as implementações alternativas. Um bom livro de receitas dá aos desenvolvedores esse conceito.
73+
Esta seção é exigida quando você fornecer a seção acima sobre quando evitar. É importante explorar outros métodos para que as pessoas que ouviram que algo é um antipadrão em certas situações não fiquem só imaginando. Ao fazer isso, considere que a web é uma grande tenda e que muitas pessoas possuem estruturas diferentes de base de código e que estão resolvendo problemas diferentes. O aplicativo é grande ou pequeno? Eles integrarão o Vue em um projeto existente, ou irão construir do zero? Seus usuários estão tentando alcançar uma finalidade ou muitas? Há muitos dados assíncronos? Todas estas considerações irão impactar as implementações alternativas. Um bom livro de receitas dá aos desenvolvedores esse conceito.
7474

7575
## Obrigado
7676

77-
Tempo é necessário para contribuir com a documentação, e se você passou tempo elaborando um PR para esta seção de documentos, você fez isso com a nossa gratidão.
77+
É necessário tempo para contribuir com a documentação, e se você usou seu tempo elaborando um PR para esta seção da documentação, você fez isso com a nossa gratidão.

0 commit comments

Comments
 (0)