Platon Technologies
not logged in Login Registration
EnglishSlovak
open source software development celebrating 10 years of open source development! Sunday, October 18, 2026
[BACK] [TXT][DIR] Up to [Platon] / doc / soft-doc-sys / sgml / en

Diff for doc/soft-doc-sys/sgml/en/introduction.sgml between version 1.3 and 1.4

version 1.3, 2002/12/16 11:48:38 version 1.4, 2002/12/17 22:34:01
Line 1 
Line 1 
 <!-- $Platon: Platon.SK/doc-projects/soft-doc-sys/en/introduction.sgml,v 1.2 2002/12/11 18:16:12 nepto Exp $ -->  <!-- $Platon: Platon.SK/doc-projects/soft-doc-sys/en/introduction.sgml,v 1.3 2002/12/16 11:48:38 nepto Exp $ -->
   
 <chapter id="introduction"><title>Introduction</title>  <chapter id="introduction"><title>Introduction</title>
   
Line 26  of documentation:
Line 26  of documentation:
 <orderedlist numeration="arabic">  <orderedlist numeration="arabic">
 <listitem><para>User-oriented documentation</para><para>  <listitem><para>User-oriented documentation</para><para>
   
 Common user is usually not interested in software architecture nor it.s inner  Common user is usually not interested in software architecture nor its inner
 implementation.  He or she does not care how things are done, what means and  implementation.  He or she does not care how things are done, what means and
 programming languages were used in the process of development.  What interests  programming languages were used in the process of development.  What interests
 him/her the most is how the program runs, how is it used and also in what  him/her the most is how the program runs, how is it used and also in what
Line 48  that it will be read by person who doesn
Line 48  that it will be read by person who doesn
   
 A developer working on a project needs to have documented all the inner  A developer working on a project needs to have documented all the inner
 technical matters of the software, such as class inheritance hierarchy, data  technical matters of the software, such as class inheritance hierarchy, data
 structure description as well as it.s attributes, list of source files, global  structure description as well as its attributes, list of source files, global
 identifiers etc.  The description of the correct use of corresponding  identifiers etc.  The description of the correct use of corresponding
 development tools used for the program creation should also be included.  development tools used for the program creation should also be included.
   
Line 69  or the other way around.  The developer-
Line 69  or the other way around.  The developer-
 along with the program creation.  If the inner implementation of structure  along with the program creation.  If the inner implementation of structure
 changes, the corresponding part of documentation is changed as well.  It is  changes, the corresponding part of documentation is changed as well.  It is
 reasonable to start writing the user-oriented documentation as soon as possible,  reasonable to start writing the user-oriented documentation as soon as possible,
 but this should not be before the program reaches it.s basic functionality.  but this should not be before the program reaches its basic functionality.
   
 </para>  </para>
 <para>  <para>
Legend:
Removed from v.1.3  
changed lines
  Added in v.1.4
Platon Group <platon@platon.org> http://platon.org/
Copyright © 2002-2006 Platon Group
Site powered by Metafox CMS 		Go to Top