Saturday, March 20, 2010

Mid-term results & user-manual tips

I just checked our midterm report card.The results we got for our project plan and the workshop are quite encouraging!

There is a note on group work which says "it's good to check that each team member has equal role, influence and workload in the group". I guess the workloads are evenly distributed among the team members and the fact that we are reviewing individual tasks every week will ensure that it will be the case till the end of the project.

On another topic, I was looking for tips on how to prepare the user manual. Here are some general guidelines -

  • Make sure the instructions actually map on to the product in all respects.
  • Include a one-page quick start guide.
  • Present instructions as step-by-step procedures.
  • Tell the user what functions there are and what they are for.
  • Write the user manual in synch with the product's development timeline — not under pressure of shipping deadlines (this is an interesting point!).
  • User-test the product and the user manual with real users (including disabled users) (perhaps not applicable at the moment).

We can use these tips as guidelines for shaping our user manual.

No comments:

Post a Comment