Skip Menu |
 

This queue is for tickets about the AnnoCPAN CPAN distribution.

Report information
The Basics
Id: 79667
Status: open
Priority: 0/
Queue: AnnoCPAN

People
Owner: Nobody in particular
Requestors: RCAPUTO [...] cpan.org
Cc:
AdminCc:

Bug Information
Severity: Wishlist
Broken in: (no value)
Fixed in: (no value)



Subject: +/- ratings buttons for each paragraph
Download (untitled) / with headers
text/plain 156b
Allow readers to vote up/down paragraphs they like or feel need work. Prompt for annotation on the dislike, but allow feedback without so much investment.
Download (untitled) / with headers
text/plain 820b
Oh, the reason I'm asking for this feature: I was discussing automated documentation testing with someone on IRC. There's really no way for software to gauge a human's ability to understand and use documentation. So there'd need to be a way for humans to pass/fail the documentation manually. AnnoCPAN could become a Mechanical Turk-Like framework for humans to pass/fail documentation. A +/- button would let people pass or fail the documentation one paragraph at a time. Distribution and module summary reports would round out the feature. Authors could quickly find hot spots in their documentation. Maybe later an API could let authors write a TAP test to fail a module if it has outstanding documentation problems. It would need to be clever about ignoring failures for paragraphs that have changed.


This service is sponsored and maintained by Best Practical Solutions and runs on Perl.org infrastructure.

Please report any issues with rt.cpan.org to rt-cpan-admin@bestpractical.com.