Project:PD help
Other languages: | English • čeština • Deutsch • Zazaki • español • français • Bahasa Indonesia • italiano • 日本語 • 한국어 • Ripoarisch • português • português do Brasil • русский • Türkçe • Tiếng Việt • 中文 |
---|
Project:PD help is a project to create a set of concise user help pages for MediaWiki users, i.e. for visitors to a website which is powered by MediaWiki. The project covers all content in the Help namespace. The main entry point for this is Help:Contents . This help documentation is separate from the Manual (the GFDL or CC BY-SA-licensed MediaWiki administrator's manual). Contributors, please be clear about the differences! The PD help pages do not contain information for server administrators, about how to install, configure, or maintain MediaWiki software. See the 'Goal' section below, for a detailed statement of what we are trying to achieve.
GoalThe idea is to provide a set of pages which can be copied into a fresh wiki installation, or included in the mediawiki distribution. This will include basic user information and other Meta information, in a reasonably concise form. The basic concept is to create a compressed user guide, not a reference work. It should focus on what users want and not explain other functions. LicenseContributions to the PD Help are released as public domain via the CC0 waiver. This is necessary in order to allow people to easily copy the text into their own wiki installations. Please ensure you understand the following before contributing:
Target readership: Normal usersThe help pages are very much targeted at normal visitors to a wiki website. Not server administratorsWe are not aiming to duplicate the full MediaWiki documentation. Information targeted at server administrators, detailing installation, configuration or maintenance of MediaWiki, belongs in the Manual. The only small exception to this is the 'Admin tips' boxes (described below). Information for sysop / bureaucrat users less prominentThe help pages would not be complete without also describing what 'sysop' users can do. However, these more advanced features are not available to a majority of the target audience (most wiki users). As such, this information is to be kept a little bit separate, so that normal users are not confronted with information which is not relevant to them. Within the bulk of the Help pages there will be brief mentions of things which require sysop privileges, but detailed descriptions of sysop procedures should be tucked away on less prominently linked pages, or should be left out of the Help pages altogether. This section is under discussion Editorial guidelines
Formatting
Screenshot imagesScreenshots are useful. PD help pages should contain only public-domain screenshots; avoid logos in screenshots and upload them to Commons with {{MediaWiki screenshot}} (for GPL) and {{CC-zero}} (for the user's work) license templates. Images are shipped with the documentation or accessed from Commons with InstantCommons . Admin tipsIf something in Help can be configured by a server administrator, you can insert an admin tip with CategoryAll pages in the "Help:" namespace are by definition part of this public domain Help documentation project and should be categorized Category:Help . Help pages for MediaWiki extensions should be categorized in its subcategory Category:Extension help . The former category for pages in the "Help:" namespace, this public domain Help documentation project, was Category:PD help. In keeping with simplicity the category is now simply Category:Help and all pages have been updated. See also
|