[Year 12 IT Apps] U4O1 question re User Doc

[Mark KELLY]

I'd argue that "the obvious" should not be left out.  What is obvious to
the author of an application could well be unknown to the user.  (e.g. this
example <http://www.youtube.com/watch?v=o4MwTvtyrUQ>)

I've always considered this the bare minimum for documentation:

- Opening the application
- Adding/editing data
- Producing output
- Saving data
- Exiting the application

Another minimum expectation is the use of headings to divide the
documentation into logical sections.

Hope that helps

I do simplify things for kids by telling them that the documentation's user
will be using a computer exactly the same as they are using, on the same
network.

On 17 July 2012 12:24, Andrew Shortell <shortell at get2me.net> wrote:

> Congrats to Stacey
>
> Also you do not need to put in the obvious like how to open
> Just the material on what to do with the solution to use it effectively
>
> Now you have broken the ice, write more
>
> Andrew
>
> CRC Melton
> VITTA CoM member
> Educator
>
> (I love my own advice; sometimes I even take it myself)
>
> On 17/07/2012, at 10:22 AM, Mark KELLY <kel at mckinnonsc.vic.edu.au> wrote:
>
> Hi Stacey. Welcome to the list.
>
> I often give my students a choice of appropriate tools. For example with
> web design some prefer Dreamweaver while others write raw HTML in a text
> editor. As long as they satisfy the requirements of the task, students can
> use any tool that does not disobey the study design's mandates. For
> convenience, however, most kids use the tools I train them in.
>
> With the user doc, often half the kids use a web editor and half use a
> multimedia editor (Powerpoint in kiosk mode.) Inappropriate tools like Word
> or PDF are not allowed.
>
> With databases, they all use Filemaker. (Noone has ever asked to use a
> different database, but I would not let them if they did.) Trying to
> support more than one RDBMS would be too impractical.
>
>
> User documentation needs to be comprehensive, and completeness is a major
> assessment criterion. A complete user manual does not need to be too
> onerous, considering the relative simplicity of the databases produced for
> the outcome.
>
> Hope that helps.
>
> Regards
> Mark
>
>
> On 17 July 2012 09:45, Vassiliadis, Stacey D <
> vassiliadis.stacey.d at edumail.vic.gov.au> wrote:
>
>>  Hi everyone
>>
>>  This is my first time writing on the list. This is also my first year
>> teaching Year 12 IT Apps. So thank you to everyone for all the help and
>> guidance I have received.
>>
>>  I just wanted clarify something about the User Documentation part of
>> U4O1. Can the students choose which multimedia program to use or does it
>> need to be a uniform decision for the whole class? Also, do they need to
>> complete the whole User Doc so that every step is shown on how to use the
>> Database or do they only need to complete part of it?
>>
>>  Thanks again to everyone for all your help. Greatly appreciated!
>>
>>  Kind regards
>>
>>    *Stacey Vassiliadis*
>>  ICT and e-Learning | Footscray City College
>>  Kinnear Street   |   Footscray   |   3011
>>  (T) +61 3 8371 1527   |   (F) +61 3 8387 1599
>>  www.footscray.vic.edu.au
>>
>> Vassiliadis.Stacey.D at edumail.vic.gov.au
>>
>>
> --
> Mark Kelly
>
>


-- 
Mark Kelly
Manager of ICT, Reporting, IT Learning Area
McKinnon Secondary College
McKinnon Rd McKinnon 3204, Victoria, Australia
Direct line / Voicemail: +613 8520 9085, Fax +613 9578 9253
kel at mckinnonsc.vic.edu.au << use this, not Edumail please!
VCE IT Lecture Notes: http://vceit.com
Moderator: IT Applications Edulist

--
The illiterate of the 21st century will not be those who cannot read and
write, but those who cannot learn, unlearn and relearn - Alvin Toffler.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://www.edulists.com.au/pipermail/itapps/attachments/20120717/073edbb7/attachment-0001.html