Guidelines for lesson texts

[tomasherceg]

I have reviewed both English and Czech versions of the lessons and I think we should write some guidelines. This list is not complete and I'll be happy to update it with any other rules or guidelines that are reasonable. Please add your suggestions in comments.

General rules

• The language should not be too formal.
• The lessons assumes the reader has at least basic knowledge of C# and HTML.
• The lessons and language used should be understandable to high school students.
• Proper casing should be respected for the following terms and abbreviations: DotVVM, View, ViewModel, DotHTML

English

• All instructions (something that the user should do) should be in the following form: "Add the Button control in the page."
• All introduction and conclusion sentences "we" or "let's" form: "In this lession, we'll create the ToDo List."
• All words except preposition in titles and headings should be in capitals (e.g. Getting Started, Validation in DotVVM).
• The same rule applies to links to chapters in the documentation (e.g. Binding Context). However, the following usages without the link to the docs should not use capitals any more (binding context).
• When describing a particular property or method in the ViewModel, we should use "the" and specify whether it's a property or a method: the FirstName property, the Add method etc.

Czech

• Instrukce pro uživatele píšeme v přikazovacím způsobu: "Přidejte do stránky komponentu Button."
• Úvodní a závěrečné sekce píšeme v první osobě čísla množného: "V této lekci si ukážeme, jak vytvořit jednoduchý seznam úkolů."
• Control překládáme jako komponenta.
• Property překládáme jako vlastnost.
• Pozor na pořadí slov - FirstName vlastnost nebo Add metoda je špatně, je třeba to prohodit - vlastnost FirstName, metoda Add.