Tutorial by Examples

Most of the guidance for creating good examples for Q&A carries over into the documentation. Make it minimal and get to the point. Complications and digressions are counterproductive. Include both working code and prose explaining it. Neither one is sufficient on its own. Don't re...

Prompts If you want your code to be copy-pastable, remove prompts such as R>, >, or + at the beginning of each new line. Some Docs authors prefer to not make copy-pasting easy, and that is okay. Console output Console output should be clearly distinguished from code. Common approaches inclu...