Wikimedia

Twinkle: Write documentation for Twinkle's Protect (RPP) module

Twinkle is a popular JavaScript gadget used by thousands of Wikipedians to accelerate common maintenance tasks. The code is hosted on GitHub.

Twinkle's documentation is in a bad state. The CSD, PROD and XFD modules are well documented. However, documentation is practically non-existent for some of the other modules.

Your task is to write documentation for Twinkle's Protect (RPP) module. The documentation that you write will be similar to those for the CSD, PROD and XFD modules. You will draft it in your Wikipedia sandbox, and copy it to the documentation page when complete.

Writing good documentation involves:

  • using the software;
  • reading the JavaScript code to elucidate the functions of the different options and components;
  • performing research on Wikipedia to better understand the processes and functions; and
  • asking the developers for clarification as needed.

Task tags

  • documentation
  • wikipedia
  • javascript

Students who completed this task

Georggi

Task type

  • chrome_reader_mode Documentation / Training
  • assessment Outreach / Research
close

2015