[Year 12 Its] Internal documentation

[Barry Larkin]

Hi all

My thoughts are that the Help menu etc 'Could' be provided separately from
the software package (It is often in a connected file) and therefore is
external to the particular software or module.

The internal comments in the code could not be provided separately as they
would then make little or no sense and are therefore internal.

Barry Larkin
Systems Teacher
Chandler Secondary.


-----Original Message-----
From: is-bounces at edulists.com.au [mailto:is-bounces at edulists.com.au] On
Behalf Of john edwards
Sent: Thursday, 19 May 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




Important - 
This email and any attachments may be confidential. If received in error, please contact us and delete all copies. Before opening or using attachments check them for viruses and defects. Regardless of any loss, damage or consequence, whether caused by the negligence of the sender or not, resulting directly or indirectly from the use of any attached files our liability is limited to resupplying any affected attachments. Any representations or opinions expressed are those of the individual sender, and not necessarily those of the Department of Education & Training.