LSL functionality rating

From Second Life Wiki
Revision as of 13:23, 20 February 2012 by Strife Onizuka (talk | contribs) (Created page with "== Project == The goal of this project is to improve the LSL documentation by providing a sane rating system for articles. The rating system will express how hard it is to maste…")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Project

The goal of this project is to improve the LSL documentation by providing a sane rating system for articles. The rating system will express how hard it is to master and use the functionality. Secondary goals of this project are to provide a gauge for which articles need improvement and categorize them by their rating.

Articles like llSetPrimitiveParams present a challenge. It is not terribly difficult to master but it is fussy and so complex that it is difficult to use without constantly referring to the documentation. This illustrates that there are two aspects to this: difficulty and complexity. This is something we want to capture and not confuse. Beyond the base functionality and the caveats, an additional modifier is bugs. Many topics have "important issues" that modify how difficult it is to master the functionality, some are obscure edge cases, others are huge functionality changes.

Proposal

In the summary right hover info box, add a rating field to all articles. Add a new section (subsection?) detailing how the topic is difficult.

How to rate an article

To edit the rating field you would use the difficulty template {{Difficulty|<points>|<description>}}.

You do not directly set the rating field, the template lets you make the topic more difficult. Ideally when adjusting a rating you won't just use the template once but for each of the reasons for why it is difficult.

Some articles will get parts of their rating from the templates they include. Functions that utilize negative indexes are a prime example.