1. Motivation
2. Definition
3. Reporting Paper Cuts
   1. The Paper Cut has been already reported
   2. Create a new Paper Cut
   3. Voting
4. Fixing
5. Current state
6. Notification

Motivation

A single paper cut cannot be dangerous for you, but what about if there are a lot of these? In software projects like XWiki it's exactly the same. If there are only a few disturbing things (Paper Cuts), it's annoying, but you can still complete your work. But if there are a lot of such small problems, it may become very disturbing and make your work really difficult... What things do we mean? Something like this:

• several mouse clicks required, where only one should be enough
• confusing icons, texts, links
• bad colors, fonts 
• etc.

Don't let XWiki users "die from paper cuts"! Help to make XWiki more smooth, easy and intuitive to use!

Definition

The definition should help to identify the worst usability issues that affect the most users. A Paper Cut is:

• a small usability problem 
• the presence of which makes an XWiki more difficult or less pleasant to use
• that affects users by its daily work
• occurring within an existing piece of XWiki software

And yes, administrators are also users

Reporting Paper Cuts

If you want to report a Paper Cut, first search in JIRA, whether there is a similar report already.

The Paper Cut has been already reported

If you have found the report describing your problem, check its "Paper Cut" status:

• if it's specified as "reported" or "approved"
  • then everything is fine
  • vote for it (raise the importance)
  • provide further information as a comment if needed
• if it's specified as "rejected" and you don't agree at all
  • raise it at the User mailing list
• if it's not specified
  • set the "Paper Cut" value to "reported" 
  • provide further information as a comment if needed
  • add the report link to Orphaned Paper Cuts 

Create a new Paper Cut

If there are no similar reports in jira, a new jira report must be created:

• Type: improvement
• Paper Cut: reported
• describe the current problem and what you would expect
• add screenshots if needed

Voting

You can raise importance of reported Paper Cuts by voting for approved (TODO link) Paper Cuts. You can also vote for reported (TODO link) Paper Cuts, but be aware - those might be rejected...

Fixing

Reported Paper Cuts will be reviewed and the status will be changed from "reported" to "approved" or "rejected". XWiki developers consider approved paper cuts by release planning. Paper cuts with the most votes are considered at first. How many paper cuts will be fixed, depends on their current workload and difficulty of paper cuts. But you don't have to wait  If you can fix it, fix it! By the way, if you currently starts with the XWiki development, "trivial" or "easy" paper cuts may be the best entry point for you. (TODO: links to jira)

Current state

• reported
• approved
• fixed
• rejected
  (TODO jira links)

Notification

 
If you are subscribed to the User mailing list, you will receive status reports every two weeks.