[GitHub] [whimsy] rbowen edited a comment on pull request #136: Small documentation changes for less confusion.

[GitBox <gi...@apache.org>]

rbowen edited a comment on pull request #136:
URL: https://github.com/apache/whimsy/pull/136#issuecomment-1064233469


   The secretary and other admins *already have* cloaks, and so don't need this information.
   
   Once again, good documentation considers the *actual audience* of this document, and gives them only the information that they need *in the moment*, with links to further information. Information about cloaks (particularly without any hint as to what a cloak is) is superfluous here.
   
   There is no "linked documentation" on cloaks. There was, instead, a reference to a doc in svn (assuming that the reader knows that it's a reference to a doc in svn, which they likely do not) which *also* doesn't define what a cloak is. As such, any reference of cloaks in this paragraph is simply noise that does not provide useful information that the audience needs in the moment.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@whimsical.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org