User Documentation for Team Google

Attached to this blog is the user documentation for Team Google.
Do you think this is professional? Were you able to follow the instructions yourself? Any other feedback?
We would appreciate any feedback that you can give.
- jeseger's blog
- Login or register to post comments
User Documentation Draft - Comment
Your instructions to add a Google map to a webpage and adjust its features were done very professionally. The organization is set up well and the language, textual, and graphical display are consistent throughout. I did not have any difficulties following the instructions. The screenshots are appropriately placed, allowing me to see where I should be. If some of them were a little larger it would be a little nicer. I have difficulties reading the figure at the top of page 8. If it could be made more like the figure on page four, it would be considerably more useful. Overall, I think the instructions look great.
User Doc comment
The instructions that the group wrote on how to implement Google maps into a webpage using Dreamweaver were done very well. Everything looked very neat and organized. I agree with Matt that some of the screen captures could have been bigger. There were a couple figures that were hard to read. Also I would use figure numbers and reference them in the instructions. It looks like the team has a good grasp on what they are trying to achieve.
The user documentation
The user documentation looked really good. I would say that it seemed very profesional. I think the instructions were very clear and that users should not have a tough time going through them. I think you covered everything in the draft. Also, the screenshots enhanced your project, making it even easier for the user to navigate through. Very nicely done.
The user documentation
The user documentation looked really good. I would say that it seemed very profesional. I think the instructions were very clear and that users should not have a tough time going through them. I think you covered everything in the draft. Also, the screenshots enhanced your project, making it even easier for the user to navigate through. Very nicely done.
The user documentation
The user documentation looked really good. I would say that it seemed very profesional. I think the instructions were very clear and that users should not have a tough time going through them. I think you covered everything in the draft. Also, the screenshots enhanced your project, making it even easier for the user to navigate through. Very nicely done.
16-1: Comments
Your documentation looks very clean, professional, and easy to follow. The screen shots help immensely in visualizing the steps required to complete the process. My one suggestion would be to enclose code in boxes or some way to designate it (other than color, since this may be printed in black and white). Also generally code is represented in a fixed-width font so you may want to consider that. Other than those minor formatting suggestions, it looks great!
Peer Review
Your instructions draft looks good so far. I am curious why you chose to use Dreamweaver since all you’re doing is editing HTML/JS, unless you know your client has and uses it. However, the content looks good. One thing I would recommend is that in copy-paste sections, clearly denote in the code what needs to be replaces. For example the MYKEY attribute value in the code could be bold and/or in another color. As someone who has written quite a lot of example code which others c/p, I know things like that often get missed even though it’s explained below. The above comment to format code specially is also a good one. Standard practice is to use a fixed-width font, such as Courier New; having some kind of border would help too. Finally, I see one thing which I think is an error: you say to make sure additional code follows ‘map.setCenter(new GLatLng(-41.5, -185), 5);}}’. I think those last two braces shouldn’t be there. Apart from that, it seems you’ve done a good job and covered a lot of material.