head	1.4;
access;
symbols;
locks; strict;
comment	@# @;


1.4
date	92.08.04.11.36.56;	author doc;	state Exp;
branches;
next	1.3;

1.3
date	92.08.04.10.25.26;	author doc;	state Exp;
branches;
next	1.2;

1.2
date	92.08.04.09.58.37;	author doc;	state Exp;
branches;
next	1.1;

1.1
date	92.01.09.15.42.23;	author doc;	state Exp;
branches;
next	;


desc
@Documentation made simple
@


1.4
log
@Changed Document number field
@
text
@{\rtf1\ansi \deff0\deflang1024{\fonttbl{\f0\froman Times New Roman;}{\f1\froman Symbol;}{\f2\fswiss Arial;}{\f3\froman Tms Rmn;}{\f4\fswiss Helv;}{\f5\froman Palatino;}{\f6\fmodern Courier;}{\f7\froman ZapfChancery;}
{\f8\fdecor ZapfDingbats;}{\f9\froman NewCenturySchlbk;}{\f10\fdecor MT Symbol;}{\f11\froman Bookman;}{\f12\fdecor Fences;}{\f13\fswiss AvantGarde;}{\f14\fmodern Modern;}{\f15\fmodern MS LineDraw;}{\f16\froman Roman;}{\f17\fscript Script;}}
{\colortbl;\red0\green0\blue0;\red0\green0\blue255;\red0\green255\blue255;\red0\green255\blue0;\red255\green0\blue255;\red255\green0\blue0;\red255\green255\blue0;\red255\green255\blue255;\red0\green0\blue127;\red0\green127\blue127;\red0\green127\blue0;
\red127\green0\blue127;\red127\green0\blue0;\red127\green127\blue0;\red127\green127\blue127;\red192\green192\blue192;}{\stylesheet{\s231\li720\ri720\tldot\tx8280\tqr\tx8640 \f3\fs20\lang2057 \sbasedon0\snext0 toc 2;}{\s232\ri720\tldot\tx8280\tqr\tx8640 
\f3\fs20\lang2057 \sbasedon0\snext0 toc 1;}{\s242\tqc\tx4320\tqr\tx8640 \scaps\f3\fs20\lang2057 \sbasedon0\snext242 footer;}{\s243\tqc\tx4320\tqr\tx8640 \f3\fs20\lang2057 \sbasedon0\snext243 header;}{\s244 \f3\fs16\up6\lang2057 
\sbasedon0\snext0 footnote reference;}{\s245 \f3\fs20\lang2057 \sbasedon0\snext245 footnote text;}{\s252\sb360 \b\f3\lang2057 \sbasedon0\snext14 heading 3;}{\s253\sb360\keepn \b\f3\fs28\lang2057 \sbasedon0\snext14 heading 2;}{\s254\sb480\keepn 
\b\f3\fs36\lang2057 \sbasedon0\snext14 heading 1;}{\s255\li720 \f3\fs20\lang2057 \sbasedon0\snext2 Normal Indent;}{\f3\fs20\lang2057 \snext0 Normal;}{\s2\qj\sb120 \f3\fs20\lang2057 \sbasedon0\snext2 Body;}{\s3\qc\sb480 \f3\fs28\lang2057 
\sbasedon0\snext3 Byline;}{\s4\qc \b\f3\fs48\lang2057 \sbasedon0\snext2 Logo;}{\s5\fi-720\li720\sb240\tqdec\tx288\tx720 \f3\fs20\lang2057 \sbasedon0\snext2 List;}{\s6\qc \i\f3\fs48\lang2057 \sbasedon0\snext6 Title;}{\s7\li567 \f6\fs20\lang2057 
\sbasedon0\snext7 Code;}{\s8 \b\f3\fs40\lang2057 \sbasedon0\snext0 Contents;}{\s9\qj\sb168\tx5954 \f3\fs20\lang2057 \sbasedon2\snext9 FirstBody;}{\s10\qc\sb480\sa240 \b\f3\lang2057 \sbasedon4\snext10 FunctionHeader;}{\s11\absw2880 \b\f3\fs20\lang2057 
\sbasedon4\snext11 FunctionItem;}{\s12\posx2880\absw5760 \f3\fs20\lang2057 \sbasedon11\snext12 FunctionData;}{\s13\absw8640 \b\f3\fs20\lang2057 \sbasedon12\snext13 EndItem;}{\s14\qj\sb240 \f3\fs20\lang2057 \sbasedon2\snext2 BodyTop;}{\s15\qc\sb480 
\b\f3\fs28\lang2057 \sbasedon3\snext15 BylineBold;}}{\info{\title Documentation made simple}{\author Judith Wildman}{\keywords $Id: jmw92002.rtf,v 1.1 1992/01/09 15:42:23 doc Exp $}{\creatim\yr1992\mo1\dy6\hr9\min57}{\printim\yr1992\mo1\dy8\hr10\min19}
{\version1}{\edmins144}{\nofpages4}{\nofwords66022}{\nofchars68741}{\vern16504}}\paperw12242\paperh15842\margl1798\margr1798\margt1441\margb1441\gutter0 \widowctrl\ftnbj\ftnrestart \sectd \sbknone\linex0\vertalc\endnhere\titlepg {\header \pard\plain 
\s243\qc\tqc\tx4320\tqr\tx8640 \f3\fs20\lang2057  Genesis by Itron
\par }{\footer \trowd \trgaph80\trleft-80 \cellx2880\cellx5760\cellx8640\pard\plain \s242\intbl\tqc\tx4320\tqr\tx8640 \scaps\f3\fs20\lang2057 {\field{\*\fldinst {\plain \i\f3\fs20\lang2057 subject}}{\fldrslt }}{\plain \i\f3\fs20\lang2057 \cell }\pard 
\s242\qc\intbl\tqc\tx4320\tqr\tx8640 {\field{\*\fldinst date \\@@ "MMMM d, yyyy"}{\fldrslt January 8, 1992}}\cell \pard \s242\qr\intbl\tqc\tx4320\tqr\tx8640 Page {\field{\*\fldinst page}{\fldrslt 4}}\cell \pard\plain \intbl \f3\fs20\lang2057 \row 
\pard\plain \s242\tqc\tx4320\tqr\tx8640 \scaps\f3\fs20\lang2057 
\par }\pard\plain \s4\qc\sb480 \b\f3\fs48\lang2057 {\*\bkmkstart spreadsheet}{\*\bkmkend spreadsheet}do{\f1\dn4 \'e3}s
\par \pard\plain \s6\qc\sb480 \i\f3\fs48\lang2057 
\par {\field{\*\fldinst title}{\fldrslt Documentation made simple}}
\par {\field{\*\fldinst subject}{\fldrslt }}
\par 
\par \pard\plain \s3\qc\sb480 \f3\fs28\lang2057 {\field{\*\fldinst author }{\fldrslt Judith Wildman}}
\par Periheli{\f1\fs36\dn4 \'b7}n Software Limited
\par {\field\fldlock{\*\fldinst date \\@@ "MMMM d, yyyy"}{\fldrslt January 8, 1992}}
\par \pard\plain \s15\qc\sb480 \b\f3\fs28\lang2057 {\field{\*\fldinst fillin "State:" \\d "DRAFT"}{\fldrslt DRAFT}}
\par {\field{\*\fldinst fillin "Security:" \\d "PSL Confidential"}{\fldrslt PSL Confidential}}
\par \pard\plain \s3\qc\sb480 \f3\fs28\lang2057 
\par \pard\plain \s15\qc\sb480 \b\f3\fs28\lang2057 {\field{\*\fldinst fillin "Readership:" \\d "FOR: PSL General"}{\fldrslt FOR: PSL General}}
\par \pard\plain \s3\qc\sb480 \f3\fs28\lang2057 {\field{\*\fldinst {\plain \f3\lang2057 fillin "Enter Perihelion Document Number [PSL-proj}{\plain \f3\lang2057 ect-initials-year-number.version]"}}{\fldrslt {\plain \f3\lang2057 PSL-DOC-JMW-92-002.2}}}{\plain 
\f3\lang2057 \sect }\sectd \sbknone\linex0\endnhere\titlepg {\header \pard\plain \s243\qc\tqc\tx4320\tqr\tx8640 \f3\fs20\lang2057 {\field{\*\fldinst {\i title }}{\fldrslt {\i Documentation made simple}}}{\i 
\par }}\pard\plain \s8 \b\f3\fs40\lang2057 \page Contents
\par \pard\plain \s232\ri720\tldot\tx8280\tqr\tx8640 \f3\fs20\lang2057 {\field{\*\fldinst toc \\o 1-3}{\fldrslt Introduction\tab 3
\par Glossary\tab 3
\par Bibliography\tab 3
\par Quality Assurance\tab 3
\par Revision Control\tab 3
\par Templates\tab 3
\par Document Contents\tab 4
\par Documents Galore\tab 4
\par Project Plans\tab 4
\par \pard\plain \f3\fs20\lang2057 }}\pard\plain \f3\fs20\lang2057 
\par \pard\plain \s254\sb480\keepn \b\f3\fs36\lang2057 \page Introduction
\par \pard\plain \s14\qj\sb240 \f3\fs20\lang2057 Here are a few suggestions to simplify the job of writing documents.
\par \pard\plain \s254\sb480\keepn \b\f3\fs36\lang2057 Glossary
\par \pard\plain \s14\qj\sb240 \f3\fs20\lang2057 
Create a glossary to consist of terms that will be used for the development of the product concerned.  This will enable all documents to contain consistent terminology although they may be written by several people.
\par \pard\plain \s254\sb480\keepn \b\f3\fs36\lang2057 Bibliography
\par \pard\plain \s14\qj\sb240 \f3\fs20\lang2057 Create a bibliography to consist of all references referred to in the documents. This will enable consistent references to other literature although the documents may be written by several people.
\par \pard\plain \s254\sb480\keepn \b\f3\fs36\lang2057 Quality Assurance
\par \pard\plain \s14\qj\sb240 \f3\fs20\lang2057 To produce a quality product requires documentation.  The fundam
ental requirement for quality assurance is a functional specification which details how the user's requirements will be met.  This document will specify exactly what is to be produced and giving precise details of the hardware and operational environment 
in which the software will be run.
\par \pard\plain \s2\qj\sb120 \f3\fs20\lang2057 
Using the functional specification as a basis, evaluation is continually executed throughout the development of the product and the results are compared to the objectives as defined in the specification.  Any deviation id
entified can then be rectified to ensure that the software system supplied meets the specification, or that any non-conformance to meet unforeseen circumstance is brought to light for agreement.
\par \pard\plain \s254\sb480\keepn \b\f3\fs36\lang2057 Revision Control
\par \pard\plain \s14\qj\sb240 \f3\fs20\lang2057 All documentation should be stored under a revision control system of which the company standard is cvs.  If the document is complete and finalised, it should then be stored in the company's main document store.

\par \pard\plain \s254\sb480\keepn \b\f3\fs36\lang2057 Templates
\par \pard\plain \s14\qj\sb240 \f3\fs20\lang2057 All documents for a given project should be developed using the same word 
processor and the same template to achieve a coherent look and feel about the documents.  The company standard word processors are LaTeX and Microsoft Word for Windows.
\par \pard\plain \s254\sb480\keepn \b\f3\fs36\lang2057 Document Contents
\par \pard\plain \s14\qj\sb240 \f3\fs20\lang2057 The contents of the document should be organised in a structured manner and extensive use of headings should be made. 
\par \pard\plain \s254\sb480\keepn \b\f3\fs36\lang2057 Documents Galore
\par \pard\plain \s2\qj\sb120 \f3\fs20\lang2057 Documents should be produced continuously throughout the project. 
\par \pard \s2\qj\fi-360\li360\sb120 {\field{\*\fldinst SYMBOL 183 \\f "Symbol" \\s 10 \\h}{\fldrslt }}\tab Functional specification
\par {\field{\*\fldinst SYMBOL 183 \\f "Symbol" \\s 10 \\h}{\fldrslt }}\tab Software system specification
\par {\field{\*\fldinst SYMBOL 183 \\f "Symbol" \\s 10 \\h}{\fldrslt }}\tab Testing plans and results at all stages of development.  These should preferably not be written by the coder.
\par {\field{\*\fldinst SYMBOL 183 \\f "Symbol" \\s 10 \\h}{\fldrslt }}\tab Configurations.  Each time the product is implemented either for a demonstration or for real, a full description of its configuration and the environment should be document.
\par {\field{\*\fldinst SYMBOL 183 \\f "Symbol" \\s 10 \\h}{\fldrslt }}\tab User guides and maintenance guides.  These should be preferably written by someone who was not involved in developing the product.
\par {\field{\*\fldinst SYMBOL 183 \\f "Symbol" \\s 10 \\h}{\fldrslt }}\tab Glossary
\par {\field{\*\fldinst SYMBOL 183 \\f "Symbol" \\s 10 \\h}{\fldrslt }}\tab Bibliography
\par \pard\plain \s254\sb480\keepn \b\f3\fs36\lang2057 Project Plans
\par \pard\plain \s2\qj\sb120 \f3\fs20\lang2057 
Writing documents are often omitted from project plans.  If the creation of documents are included in the plans, tasks duration will be more accurately estimated and the documentation team can schedule their work more evenly over time and across the compa
ny.  In addition, documents can be produced in order of requirements and in parallel if planned correctly.
\par 
\par }@


1.3
log
@Changed other fillin fields to BylineBold
@
text
@d12 1
a12 1
{\version1}{\edmins142}{\nofpages4}{\nofwords66022}{\nofchars68741}{\vern16504}}\paperw12242\paperh15842\margl1798\margr1798\margt1441\margb1441\gutter0 \widowctrl\ftnbj\ftnrestart \sectd \sbknone\linex0\vertalc\endnhere\titlepg {\header \pard\plain 
d20 1
a20 1
\par {\field\flddirty{\*\fldinst subject}{\fldrslt }}
d22 2
a23 2
\par \pard\plain \s3\qc\sb480 \f3\fs28\lang2057 {\field\flddirty{\*\fldinst author }{\fldrslt Judith Wildman}}
\par \pard \s3\qc\sb480 Periheli{\f1\fs36\dn4 \'b7}n Software Limited
d25 2
a26 2
\par \pard\plain \s15\qc\sb480 \b\f3\fs28\lang2057 {\field\flddirty{\*\fldinst fillin "State:" \\d "DRAFT"}{\fldrslt DRAFT}}
\par \pard \s15\qc\sb480 {\field\flddirty{\*\fldinst fillin "Security:" \\d "PSL Confidential"}{\fldrslt PSL Confidential}}
d28 3
a30 3
\par \pard\plain \s15\qc\sb480 \b\f3\fs28\lang2057 {\field\flddirty{\*\fldinst fillin "Readership:" \\d "FOR: PSL General"}{\fldrslt FOR: PSL General}}
\par \pard\plain \s3\qc\sb480 \f3\fs28\lang2057 {\field{\*\fldinst {\plain \f3\lang2057 fillin "Enter Perihelion Document Number [PSL-proj-initials-year-num.ver]" }{\plain \f3\lang2057 \\}{\plain \f3\lang2057 d "PSL-DOC-"}}{\fldrslt {\plain \f3\lang2057 
PSL-DOC-JMW-92-002.2}}}{\plain \f3\lang2057 \sect }\sectd \sbknone\linex0\endnhere\titlepg {\header \pard\plain \s243\qc\tqc\tx4320\tqr\tx8640 \f3\fs20\lang2057 {\field{\*\fldinst {\i title }}{\fldrslt {\i Documentation made simple}}}{\i 
@


1.2
log
@Change State to BylineBold
@
text
@d7 1
a7 1
\b\f3\fs36\lang2057 \sbasedon0\snext14 heading 1;}{\s255\li720 \f3\fs20\lang2057 \sbasedon0\snext2 Normal Indent;}{\f3\fs20\lang2057 \snext0 Normal;}{\s2\qj\sb120 \f3\fs20\lang2057 \sbasedon0\snext2 Body;}{\s3\qc\sb240 \f3\fs28\lang2057 
d10 1
a10 1
\sbasedon4\snext11 FunctionItem;}{\s12\posx2880\absw5760 \f3\fs20\lang2057 \sbasedon11\snext12 FunctionData;}{\s13\absw8640 \b\f3\fs20\lang2057 \sbasedon12\snext13 EndItem;}{\s14\qj\sb240 \f3\fs20\lang2057 \sbasedon2\snext2 BodyTop;}{\s15\qc\sb240 
d12 1
a12 1
{\version1}{\edmins140}{\nofpages4}{\nofwords66022}{\nofchars68741}{\vern16504}}\paperw12242\paperh15842\margl1798\margr1798\margt1441\margb1441\gutter0 \widowctrl\ftnbj\ftnrestart \sectd \sbknone\linex0\vertalc\endnhere\titlepg {\header \pard\plain 
d23 1
a23 1
\par Periheli{\f1\fs36\dn4 \'b7}n Software Limited
d25 6
a30 6
\par \pard\plain \s15\qc\sb240 \b\f3\fs28\lang2057 {\field\flddirty{\*\fldinst fillin "State:" \\d "DRAFT"}{\fldrslt DRAFT}}
\par \pard\plain \s3\qc\sb480 \f3\fs28\lang2057 {\field\flddirty{\*\fldinst {\b\fs36 fillin "Security:" }{\b\fs36 \\}{\b\fs36 d "PSL Confidential"}}{\fldrslt {\b\fs36 PSL Confidential}}}{\b\fs36 
\par }
\par {\field\flddirty{\*\fldinst {\b fillin "Readership:" }{\b \\}{\b d "FOR: PSL General"}}{\fldrslt {\b FOR: PSL General}}}{\b 
\par }{\field{\*\fldinst {\plain \f3\lang2057 fillin "Enter Perihelion Document Number [PSL-proj-initials-year-num.ver]" }{\plain \f3\lang2057 \\}{\plain \f3\lang2057 d "PSL-DOC-"}}{\fldrslt {\plain \f3\lang2057 PSL-DOC-JMW-92-002.2}}}{\plain \f3\lang2057 
\sect }\sectd \sbknone\linex0\endnhere\titlepg {\header \pard\plain \s243\qc\tqc\tx4320\tqr\tx8640 \f3\fs20\lang2057 {\field{\*\fldinst {\i title }}{\fldrslt {\i Documentation made simple}}}{\i 
d50 6
a55 6
\par \pard\plain \s14\qj\sb240 \f3\fs20\lang2057 
To produce a quality product requires documentation.  The fundamental requirement for quality assurance is a functional specification which details how the user's requirements will be met.  This document will specify exactly what is to be produced and giv
ing precise details of the hardware and operational environment in which the software will be run.
\par \pard\plain \s2\qj\sb120 \f3\fs20\lang2057 Using the functional specification as a basis, evaluation is continually executed throughout the development of the product and the results are compared to t
he objectives as defined in the specification.  Any deviation identified can then be rectified to ensure that the software system supplied meets the specification, or that any non-conformance to meet unforeseen circumstance is brought to light for agreeme
nt.
d60 2
a61 2
\par \pard\plain \s14\qj\sb240 \f3\fs20\lang2057 All docume
nts for a given project should be developed using the same word processor and the same template to achieve a coherent look and feel about the documents.  The company standard word processors are LaTeX and Microsoft Word for Windows.
@


1.1
log
@Initial revision
@
text
@d1 18
a18 17
{\rtf1\ansi \deff0\deflang1024{\fonttbl{\f0\froman Tms Rmn;}{\f1\fdecor Symbol;}{\f2\fswiss Helv;}{\f3\froman Palatino;}{\f4\fmodern Courier;}{\f5\froman ZapfChancery;}{\f6\fdecor ZapfDingbats;}{\f7\froman NewCenturySchlbk;}
{\f8\fdecor MT Symbol;}{\f9\froman Bookman;}{\f10\fdecor Fences;}{\f11\fswiss AvantGarde;}{\f12\fmodern Modern;}{\f13\fmodern MS LineDraw;}{\f14\froman Roman;}{\f15\fscript Script;}}{\colortbl;\red0\green0\blue0;\red0\green0\blue255;
\red0\green255\blue255;\red0\green255\blue0;\red255\green0\blue255;\red255\green0\blue0;\red255\green255\blue0;\red255\green255\blue255;\red0\green0\blue127;\red0\green127\blue127;\red0\green127\blue0;\red127\green0\blue127;\red127\green0\blue0;
\red127\green127\blue0;\red127\green127\blue127;\red192\green192\blue192;}{\stylesheet{\s231\li720\ri720\tldot\tx8280\tqr\tx8640 \fs20\lang2057 \sbasedon0\snext0 toc 2;}{\s232\ri720\tldot\tx8280\tqr\tx8640 \fs20\lang2057 \sbasedon0\snext0 toc 1;}{
\s242\tqc\tx4320\tqr\tx8640 \scaps\fs20\lang2057 \sbasedon0\snext242 footer;}{\s243\tqc\tx4320\tqr\tx8640 \fs20\lang2057 \sbasedon0\snext243 header;}{\s244 \fs16\up6\lang2057 \sbasedon0\snext0 footnote reference;}{\s245 \fs20\lang2057 
\sbasedon0\snext245 footnote text;}{\s252\sb360 \b\lang2057 \sbasedon0\snext14 heading 3;}{\s253\sb360\keepn \b\fs28\lang2057 \sbasedon0\snext14 heading 2;}{\s254\sb480\keepn \b\fs36\lang2057 \sbasedon0\snext14 heading 1;}{\s255\li720 \fs20\lang2057 
\sbasedon0\snext2 Normal Indent;}{\fs20\lang2057 \snext0 Normal;}{\s2\qj\sb120 \fs20\lang2057 \sbasedon0\snext2 Body;}{\s3\qc\sb240 \fs28\lang2057 \sbasedon0\snext3 Byline;}{\s4\qc \b\fs48\lang2057 \sbasedon0\snext2 Logo;}{
\s5\fi-720\li720\sb240\tqdec\tx288\tx720 \fs20\lang2057 \sbasedon0\snext2 List;}{\s6\qc \i\fs48\lang2057 \sbasedon0\snext6 Title;}{\s7\li567 \f4\fs20\lang2057 \sbasedon0\snext7 Code;}{\s8 \b\fs40\lang2057 \sbasedon0\snext0 Contents;}{\s9\qj\sb168\tx5954 
\fs20\lang2057 \sbasedon2\snext9 FirstBody;}{\s10\qc\sb480\sa240 \b\lang2057 \sbasedon4\snext10 FunctionHeader;}{\s11\absw2880 \b\fs20\lang2057 \sbasedon4\snext11 FunctionItem;}{\s12\posx2880\absw5760 \fs20\lang2057 \sbasedon11\snext12 FunctionData;}{
\s13\absw8640 \b\fs20\lang2057 \sbasedon12\snext13 EndItem;}{\s14\qj\sb240 \fs20\lang2057 \sbasedon2\snext2 BodyTop;}}{\info{\title Documentation made simple}{\author Judith Wildman}{\keywords $Id$}{\creatim\yr1992\mo1\dy6\hr9\min57}
{\printim\yr1992\mo1\dy8\hr10\min19}{\version1}{\edmins135}{\nofpages4}{\nofwords486}{\nofchars3205}{\vern16504}}\paperw12242\paperh15842\margl1798\margr1798\margt1441\margb1441\gutter0 \widowctrl\ftnbj\ftnrestart {\*\template C:\\WINWORD\\DOCTEMP.DOT}
\sectd \sbknone\linex0\vertalc\endnhere\titlepg {\header \pard\plain \s243\qc\tqc\tx4320\tqr\tx8640 \fs20\lang2057  Genesis by Itron
\par }{\footer \trowd \trgaph80\trleft-80 \cellx2880\cellx5760\cellx8640\pard\plain \s242\intbl\tqc\tx4320\tqr\tx8640 \scaps\fs20\lang2057 {\field{\*\fldinst {\plain \i\fs20\lang2057 subject}}{\fldrslt }}{\plain \i\fs20\lang2057 \cell }\pard 
\s242\qc\intbl\tqc\tx4320\tqr\tx8640 {\field{\*\fldinst date \\@@ "MMMM d, yyyy"}{\fldrslt January 8, 1992}}\cell \pard \s242\qr\intbl\tqc\tx4320\tqr\tx8640 Page {\field{\*\fldinst page}{\fldrslt 4}}\cell \pard\plain \intbl \fs20\lang2057 \row \pard\plain 
\s242\tqc\tx4320\tqr\tx8640 \scaps\fs20\lang2057 
\par }\pard\plain \s4\qc\sb480 \b\fs48\lang2057 {\*\bkmkstart spreadsheet}{\*\bkmkend spreadsheet}do{\f1\dn4 \'e3}s
\par \pard\plain \s6\qc\sb480 \i\fs48\lang2057 
d22 11
a32 11
\par \pard\plain \s3\qc\sb480 \fs28\lang2057 {\field\flddirty{\*\fldinst author }{\fldrslt Judith Wildman}}
\par \pard \s3\qc\sb480 Periheli{\f1\fs36\dn4 \'b7}n Software Limited
\par \pard \s3\qc\sb480 {\field\fldlock{\*\fldinst date \\@@ "MMMM d, yyyy"}{\fldrslt January 8, 1992}}
\par \pard \s3\qc\sb480 {\field\flddirty{\*\fldinst {\b fillin "State:" \\d "DRAFT"}}{\fldrslt {\b DRAFT}}}{\b 
\par }\pard \s3\qc\sb480 {\field\flddirty{\*\fldinst {\b\fs36 fillin "Security:" \\d "PSL Confidential"}}{\fldrslt {\b\fs36 PSL Confidential}}}{\b\fs36 
\par }\pard \s3\qc\sb480 
\par \pard \s3\qc\sb480 {\field\flddirty{\*\fldinst {\b fillin "Readership:" \\d "FOR: PSL General"}}{\fldrslt {\b FOR: PSL General}}}{\b 
\par }\pard \s3\qc\sb480 {\field{\*\fldinst {\plain \lang2057 fillin "Enter Perihelion Document Number [PSL-proj-initials-year-num.ver]" \\d "PSL-DOC-"}}{\fldrslt {\plain \lang2057 PSL-DOC-JMW-92-002.2}}}{\plain \lang2057 \sect }\sectd 
\sbknone\linex0\endnhere\titlepg {\header \pard\plain \s243\qc\tqc\tx4320\tqr\tx8640 \fs20\lang2057 {\field{\*\fldinst {\i title }}{\fldrslt {\i Documentation made simple}}}{\i 
\par }}\pard\plain \s8 \b\fs40\lang2057 \page Contents
\par \pard\plain \s232\ri720\tldot\tx8280\tqr\tx8640 \fs20\lang2057 {\field{\*\fldinst toc \\o 1-3}{\fldrslt Introduction\tab 3
d41 5
a45 5
\par \pard\plain \fs20\lang2057 }}\pard\plain \fs20\lang2057 
\par \pard\plain \s254\sb480\keepn \b\fs36\lang2057 \page Introduction
\par \pard\plain \s14\qj\sb240 \fs20\lang2057 Here are a few suggestions to simplify the job of writing documents.
\par \pard\plain \s254\sb480\keepn \b\fs36\lang2057 Glossary
\par \pard\plain \s14\qj\sb240 \fs20\lang2057 
d47 4
a50 4
\par \pard\plain \s254\sb480\keepn \b\fs36\lang2057 Bibliography
\par \pard\plain \s14\qj\sb240 \fs20\lang2057 Create a bibliography to consist of all references referred to in the documents. This will enable consistent references to other literature although the documents may be written by several people.
\par \pard\plain \s254\sb480\keepn \b\fs36\lang2057 Quality Assurance
\par \pard\plain \s14\qj\sb240 \fs20\lang2057 
d53 1
a53 1
\par \pard\plain \s2\qj\sb120 \fs20\lang2057 Using the functional specification as a basis, evaluation is continually executed throughout the development of the product and the results are compared to t
d56 2
a57 2
\par \pard\plain \s254\sb480\keepn \b\fs36\lang2057 Revision Control
\par \pard\plain \s14\qj\sb240 \fs20\lang2057 All documentation should be stored under a revision control system of which the company standard is cvs.  If the document is complete and finalised, it should then be stored in the company's main document store.
d59 2
a60 2
\par \pard\plain \s254\sb480\keepn \b\fs36\lang2057 Templates
\par \pard\plain \s14\qj\sb240 \fs20\lang2057 All docume
d62 4
a65 4
\par \pard\plain \s254\sb480\keepn \b\fs36\lang2057 Document Contents
\par \pard\plain \s14\qj\sb240 \fs20\lang2057 The contents of the document should be organised in a structured manner and extensive use of headings should be made. 
\par \pard\plain \s254\sb480\keepn \b\fs36\lang2057 Documents Galore
\par \pard\plain \s2\qj\sb120 \fs20\lang2057 Documents should be produced continuously throughout the project. 
d68 1
a68 1
\par \pard \s2\qj\fi-360\li360\sb120 {\field{\*\fldinst SYMBOL 183 \\f "Symbol" \\s 10 \\h}{\fldrslt }}\tab Testing plans and results at all stages of development.  These should preferably not be written by the coder.
d71 1
a71 1
\par \pard \s2\qj\fi-360\li360\sb120 {\field{\*\fldinst SYMBOL 183 \\f "Symbol" \\s 10 \\h}{\fldrslt }}\tab Glossary
d73 2
a74 2
\par \pard\plain \s254\sb480\keepn \b\fs36\lang2057 Project Plans
\par \pard\plain \s2\qj\sb120 \fs20\lang2057 
d77 1
a77 1
\par \pard \s2\qj\sb120 
@
