User talk:COIBot/Poke
Documentation
[edit]@Beetstra:
The documentation should start with a plain English description of what the bot is and why one might use it. Right now the documentation is fine for those who are likely to use it, but if a random non-technical editor reads this page it will be pretty much incomprehensible to him. --Guy Macon (talk) 06:47, 23 March 2019 (UTC)
- @Guy Macon: You mean regarding the notice on top:
 | Instruction for COIBot/Poke
Add domains (everything before the first '/' or '?', stripped of http:// and 'www.') inside the {{LinkSummary}} template here (e.g. COIBot will queue the reported domains/IPs/Users for reporting on either Wikipedia:WikiProject Spam/LinkReports or Wikipedia:WikiProject Spam/UserReports. Poked reports in the queue have higher priority than automonitored reports, but lower priority than meta xwiki reports and IRC-requested reports. You have to be either in one of the granted groups on this wiki (settings 'grantedgroups' - currently containing all 'given' rights), or your username has to be granted (settings 'grantedusers'). These can be set by any meta admin in m:User:COIBot/Settings.css. Edits by other users adding a template to this page will be ignored by COIBot. Please use this capability responsibly. For questions, poke User:Beetstra. |
Hmm, yes, that could indeed use a sentence explaining what this page does.
'This page can be used to instruct COIBot to save reports on the use of external links. One can request 'LinkReports' for domains (showing all recorded additions of external links on said domain), or 'UserReports' for external links added by a certain user (showing all recorded external link additions for requested user). This functionality is complementary to the use on WT:WPSPAM, WT:SBL and WT:SWL.' --Dirk Beetstra T C 06:54, 23 March 2019 (UTC)
- That's good, but before that there should be something like
- "The COI bot creates reports to help keep track of edits that are made by users with a conflict of interest. See Wikipedia:Conflict of interest and Wikipedia:Best practices for editors with close associations. COI bot can track edits promoting a particular website (useful when multiple editors promote the same site, as often happens with multi-level-marketing) or it can track edits by a particular user (useful for paid editors who promote a number of different websites)."
- The first paragraph is for the compete newbie (or a COI editor!) who may not even know what a domain or an external link is.
- Imagine a 6th grader who stumbles upon the name "COI bot" and thinks" Coi? Aren't those the giant goldfish? Somebody made robot goldfish? Cool! Clicking on the link to learn about robot goldfish now..." What would be a good first sentence for our 6th grader to read? --Guy Macon (talk) 08:56, 23 March 2019 (UTC)
- @Guy Macon: that is something that is on User:COIBot#The_bot. Now I agree that that could be more elaborate (why 'COIBot' as a name) - where you are commenting now is just for the 'poke' facility of the bot. --Dirk Beetstra T C 09:31, 23 March 2019 (UTC)
- Right. That was just an example off the top of my head to demonstrate what a plain English description at the top might look looks like. Obviously the real description should be written by someone who actually knows something about the bot. But it should not be too detailed or too technical. :) --Guy Macon (talk) 09:37, 23 March 2019 (UTC)