User:Jan Dittrich (WMDE)/goodDocumentation

Examples

 * Hoodie
 * Pywikibot
 * MediaWiki

Patterns

 * Sections with Lists: Pywikibot MediaWiki
 * Provide Search
 * Use nontechnical language
 * Use examples. Working ones that can be tried out, ideally verbatim (e.g. if you write about how a URL looks like, don't write: https://fakewikipage.org/fakepage but https://de.wikipedia.org/wiki/Wikipedia:Hauptseite)
 * Provide a tutorial
 * Be specific. Don’t assume that you can leave out something just because the »User probably knows that it is unimportant« or »We said it on another page already«. Think of reading a book on maths and the feeling of »how did that equation transform into this?«. Well, the transformation is probably right and also how this works has been stated a few pages before (or is expected to be common knowledge). But you still have not a great experience in that approach.
 * Lower barriers. You provide a link to an IRC – great. Even better: Provide a link to a web IRC client, so that people can join who don't have a client or even don't know IRC.

Antipattern

 * Prioritize rare and/or unusual cases