[Year 12 Its] Internal documentation

[Allan Barnes]

John, my guess is that it would be external help as it is available to the
end-user of the software, and assists them in how to use the functions of
the software. Internal documentation is generally only available to the
programmer and comments on the intent of the code, etc.

Kind regards

Allan Barnes, CEO
Australian Institute of Education and Training
Phone: (03) 9387 2051
FAX:    (03) 9387 3470
Mobile: 0409 428 221
E-mail: abarnes at aiet.com.au

-----Original Message-----
From: is-bounces at edulists.com.au [mailto:is-bounces at edulists.com.au] On
Behalf Of john edwards
Sent: Thursday, May 19, 2005 2:43 PM
To: is at edulists.com.au
Subject: [Year 12 Its] Internal documentation

Hi All,

I have a quick question regarding documentation.

I have told my class that internal documentation consists of comments within
the coding and the documenting of variables and the like so that their names
form documentation (extrinsic and intrinsic).

My question is whether, Help that comes with a software package like Word or
Excel, is considered internal or external. The Help itself must form part of
the software so does that mean it is internal or since it is available only
at run time is it considered external?

Any assistance would be appreciated.

Cheers,

John Edwards
Gippsland Grammar School
Sale

_______________________________________________
http://www.edulists.com.au
IT Systems Mailing List kindly supported by
http://www.vcaa.vic.edu.au - Victorian Curriculum and Assessment Authority
and
http://www.vitta.org.au  - VITTA Victorian Information Technology Teachers
Association Inc