Team Boilers User Documentation Draft

yakyma94's picture

Our user documentation is focused on a  user who will be creating a group.  Our user intends to use this group as a learning to for a freshman engineering class.  This means that every year there will be a new group of members joining this facebook group. In the event that the current group creator must leave the group, he/she will be able to easily pass it  on to another faculty member by inviting them to join and then making  them an officer.  The new professor, as well as teachers assistants and possibly some  class members will be able to edit content and membership of the group.  Our main focus is to assist the professor in setting up a secure and useful group where student and faculty can post news, asks questions, and in general improve the learning environment for all new freshman engineering students.

Please follow through the instructions to see if there are any areas where we may be lacking.  Were you already a member of facebook?  Had you created a group prior to using these instructions?  Did you find the instructions thourough and detailed?  Would you be comfortable setting up a group with the proper security level and optionsfrom those available?  In general do you feel a new user would be comfortable with these instructions?

Peer Review Comment

srwalker's picture

I think your documentation covers the right amount of content for a user wishing to create and administrate a group.  Facebook is a pretty user friendly site in general so I feel that these instructions are detailed enough without making the process seem complicated.  The organization and formatting looks great as well. 

Illustrations draft comment

nateth3gr8's picture

Your instructions seem very useful.  The formatting and spacing create a very user-friendly flow to the document.  The headings clearly denote each section of the tutorial.  With instrucitons like these, I would be more confident in spending time in dealing with groups on Facebook. The internet can be a scary place, but with instructions like these, they can be much safer.

User Documentation Review

While everything looked pretty good, I do have a few critiques. "First, Select the 'Network,' from the drop down box." not form. Secondly, I am not sure how useful the Notice about clicking with the left mouse button is, it made me laugh a little because it is so obvious. Most people, and all faculty, know how to use the internet, and if they don't, they should not be making Facebook Groups for ENGR126. It was a little distracting to me to instruct me how to use the Internet. And in the notice, why does it reference Fig. 2.1? I would move the Figures closer to where they are referenced. There is a page between the reference to 4.1 and its image. Your last few screen captures are really pixelated, I would try to fix those, and I didn't really like the flowchart, it does not seem needed (and there is a typo oinly in it). Also remove the frame around the Figure label. And finally, and quite importantly, do not show Microsoft Paint in the screen captures. Whoever is reading the user documentation will be confused that what they see on the screen is much different than the image. And if they know it is MS Paint, they might laugh that you used MS Paint to edit photos. Also, I would use a non-serif font, since it seems to be the norm in Web 2.0 (look around on Facebook, you never see serif fonts there) and I think Kevin explicitly told me to use a non-serif font before. Anyways, good job, it seems to be a well done project.

Comment

I like the length of your instructions, they arent too long or too short.  It is easy to use because the begining part is very organized and simplistic.  As the document progresses it is good that there is more content to describe all the differnt feature withen creating a group.  I like how well labled the figures are and how the document overall can be used by people of diffent facebook skill levels.