Help:Requesting documentation
From LokDoc
Requesting documentation is fairly easy. It is done by using templates.
Contents |
Requesting articles
Lets say you want to request a whole new article about something. As an example you might want to request an article about a word that is used a lot in the documentation, or a large part of a program that isn't documented. All you have to do is create the article and write what you want it to contain, then write {{Request-article}} and save it. That will mark the article as a requested article and someone will write it when they get the time.
Example
You want to know what foo means, so you try to go to the article, but it doesn't exist. You are instead presented with an editing screen, so you write.
Please explain what "foo" means, it is used a lot in the documentation, but never explained.
{{Request-article}}
The article is saved and gets marked as "requested", then someone who has the time writes it.
Writing a requested article
All articles that are marked as "requested" end up in Category:Requested articles. Anyone who feels that they can contribute to the article can then edit those articles, writing some contents on the requested topic, and then remove the {{Requested-article}} part so that it is no longer marked as "requested".
Requesting sections
If existing documentation lacks a certain section, some part which isn't explained sufficently, then you can request them. All you have to do is edit the article and insert {{Request-section|topic}}, replacing "topic" with the topic that you want the requested section to cover. Please place the tag where you think that the new section should be created, i.e. avoid placing it before the article actually begins (unless of course the section should for some reason come before the beginning).
Example
The menu option named "foo" is not covered in the documentation, so you click "edit" and add the following amongst the section that covers menu options.
{{Request-section|Please cover the menu option foo, it is not documented.}}
Writing a requested section
All articles with a requested section end up in Category:Requested sections. Anyone who feels that they can explain the topic can then edit those articles, replacing the {{Request-section|topic}} tag with the actual section.
Requesting clarifications
Certain parts of a documentation may sometimes lack in clarity. It might be poorly written, hard to understand, ambiguous or just downright wierd. If you can then please go ahead edit them, otherwise you can also request that someone does it for you. That is done by placing {{Request-clarification|reason}} directly above the paragraph, replacing "reason" with the reason that the paragraph needs to be clarified.
Example
You are reading some documentation and suddenly you come upon a strange paragraph that contains things similiar to the following.
The plane will jolt at null bil.
The sentences suddenly stop making sense in the context and need to be clarified, so you click "edit" and turn it into the following.
{{Request-clarification|The following paragraph makes no sense.}}
The plane will jolt at null bil.
Performing a clarification
All articles with a requested section end up in Category:Requested clarifications. Anyone who feels up to the task can clairify (or remove) the paragraph, removing the {{Request-clarification|reason}} tag.
