GDS User Documentation Draft
Here is our user doc draft. All comments and feedback are appreciated. GDS is mainly concerned with overall effectiveness of the document, formatting errors (some of these are due to the .pdf conversion) and grammatical errors. Please review our draft with these things in mind.
- srwalker's blog
- Login or register to post comments
User Documentation Draft Peer Review
Overall, it looks like a pretty strong document.
- I would make sure the Table of Contents numbers on page 1 are right aligned. It's a bit sloppy looking otherwise. You can actually insert a TOC in Word, so I'd look into that. It'll make the formatting neater.
-Also in the TOC, the word "started" in the heading for Section 1 should be capitalized
-I would put a bit more white space into your document. It looks a little cramped and can be kind of hard to keep track of where you are. Putting a line between numbered steps would help.
-I would put captions on a couple of your figures. On page 4 especially, I looked at the pictures and didn't really know what they were showing me until I reread the section above. Even something as simple as putting a border around those two graphics would help to seperate them from the instruction text.
-I'd also put a link to some kind of additional resource if they get stuck using Google Docs....maybe just the Google help site itself.
I was a bit picky about a couple of things, but overall, easy to follow and understand. I think you've got a strong product for your client!
Feedback
Thanks for the feedback...the formatting was all much better in the word document, but as soon as I converted it the numbers in the TOC moved around and the spacing between paragraphs was compromised. I've never had this problem with converting .doc files to .pdf. If anyone has any suggestions to overcome this we would greatly appreciate them.
User Documention Comment
Overall I thought your project looked excellent. I really liked your use of screen shots, Ifealt like they were used in the neccesary spots. I also thought your formatting was very good. The sections were broken up very clearly and it was easy to follow. The steps were very clear and simple. I think you guys did a great job.
Comment on user documentation
The user documentation for using google documents looks very
good. I like the format you used on this
document as it is very easy to follow. The
contents section is nice since it allows you to go to a certain section you are
stuck on easily by looking up what page it is on since it is a fairly long set
of instructions. You make good use of
screen shots in your instructions with circles and arrows to show what exactly
you are talking about. The buttons you
inserted also look good again allowing the user to see what they will actually
be clicking on. Overall it looks like a very
good user documentation.