Documentation/Guidelines

So, you want to write documentation? Great! I guess we should write up some guidelines about how to do that...


 * Bug the development team about what you do, and ask us questions. We're quite friendly! See Development - we tend to hang out in IRC or on the mailing list more than here, however.
 * The main priority is maintaining the Official Manual.
 * Screenshots are good. They should be uploaded as files hosted on the wiki itself.
 * Document only stable versions.
 * When editing documentation, please be specific about the version of MyPaint you're documenting. Date your documentation, even in comments, or mention versions in the text.
 * For sections, use Template:DocumentsVersion: this links to the release page for the version automatically.
 * Limit the number of inline version references: it's best to update the entire section instead.
 * Templates can't be imported from Wikipedia due to licensing incompatibility. This wiki has something of its own house style evolving though - follow that. It's also OK to follow house rules and writing guidelines from Wikipedia if it makes the documentation more familiar-looking to users.
 * The wiki attracts user questions on high-profile pages. Consider moving them to Documentation/FAQ if they have complete answers, or to the page's talk page. The goal is to keep documentation pages free of clutter. Refer confused users to the forums, the mailing list, or to IRC or the bug tracker depending on the nature of the issue.