[Year 12 Its] Internal documentation

[James Poulos]

I remember discussing this issue with my students last year. My
understanding was that from an end-user perspective, internal
documentation was things like tooltips on buttons etc, but a help file
is external, basically an electronic version of a book.

James

**********************************************
James Poulos
IT Coordinator
Cranbourne Christian College
jpoulos at crancc.vic.edu.au
Ph: 03 5995 2188
**********************************************

-----Original Message-----
From: is-bounces at edulists.com.au [mailto:is-bounces at edulists.com.au] On
Behalf Of Robert Timmer-Arends
Sent: Thursday, 19 May 2005 7:58 PM
To: Year 12 Information Technology Systems Teachers' Mailing List
Subject: Re: [Year 12 Its] Internal documentation

I agree with Barry and Allan. Just becuase 'help' can come as part of
the software package does not make it internal documentation.
Traditionally, internal documentation has meant that documentation that
is embedded with the code (comments, descriptive names, use of
indentation...) and is intended to help in the maintenance of the
program, not its use. I guess it has become a bit blurred with
'programmable' application software such as spreadsheets and dbs but I
think the principle still stands: internal documentation is there to
help in the maintenance of the 'solution', not in its use.

Regards
Robert T-A
Brighton SC


----- Original Message -----
From: "john edwards" <john.edwards at gippslandgs.vic.edu.au>
To: <is at edulists.com.au>
Sent: Thursday, May 19, 2005 2:42 PM
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

_______________________________________________
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

**************************************************************************************
Disclaimer: 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 Cranbourne Christian College.