documentation/specification/doc_spec.txt

Document Specification
======================

ajm4, 08/03/2001
pjm2, 19/10/2000

Electronic Standard
-------------------

Standards to adhere to: -

    All documents must be saved as plain text with no more
    than 60 characters per line.

    Documents must be saved with a '.txt' file extension.

    The text file must not contain any HTML tags.
    This is to prevent problems when the file is included
    as the contents on an SHTML page.


Other issues

    If possible, please save the text files in 'Windows'
    format, such that each line is separated by a return
    and also a linefeed character.
    
Publication Standard
--------------------

All documents must use the Word template file that can be
found in CVS:

    CVSROOT:/documentation/i-scream-template.dot

1)
The tags <SECTION NAME> and <DOCUMENT NAME> are Word fields
and should NOT be manually changed.  Instead they should be
changed by click File->Properties, where:

    "Title" -> <SECTION NAME>
    "Subject" -> <DOCUMENT NAME>
    
The "Title" and "Subject" fields should be used in ALL areas
where the name of the section or document are needed.

2)
All text should make use of "Styles".  There should be NO
hardcoded text formatting in the document.  If you wish to
change the appearance of a specific style you should change
the document template only.

3)
No changes should be made to the layout of the opening page,
the header or the footer.  Again, all changes should be made
to the template only.

4)
All major changes to a document must have a full revision
entry on the opening page.  This change must also be
verified by a nominated member of the team.

5)
The table of contents must be the first page after the
opening page (including any revsion history).  This should
also NOT be manually edited for a specific document and
again, all changes should be made in the template file ONLY.

Notes :-

To ensure your document is using the latest template, update
CVS and click Tools->Templates and Add-ins then Attach. This
should ensure that all the latest template changes are
applied to your document.

All the above has been tried with Word 2000 *only* some
testing will need to be done to ensure that it is compatible
with Word 97.
Revision:	1.2
Committed:	Thu Mar 8 00:32:15 2001 UTC (23 years, 2 months ago) by ajm
Content type:	text/plain
Branch:	MAIN
Changes since 1.1:	+56 -1 lines
Log Message:	New publication standard entered. May need revising.
#	User	Rev	Content
1	tdb	1.1	Document Specification
2			======================
3
4	ajm	1.2	ajm4, 08/03/2001
5	tdb	1.1	pjm2, 19/10/2000
6
7	ajm	1.2	Electronic Standard
8			-------------------
9	tdb	1.1
10			Standards to adhere to: -
11
12			All documents must be saved as plain text with no more
13			than 60 characters per line.
14
15			Documents must be saved with a '.txt' file extension.
16
17			The text file must not contain any HTML tags.
18			This is to prevent problems when the file is included
19			as the contents on an SHTML page.
20
21
22			Other issues
23
24			If possible, please save the text files in 'Windows'
25			format, such that each line is separated by a return
26	ajm	1.2	and also a linefeed character.
27
28			Publication Standard
29			--------------------
30
31			All documents must use the Word template file that can be
32			found in CVS:
33
34			CVSROOT:/documentation/i-scream-template.dot
35
36			1)
37			The tags <SECTION NAME> and <DOCUMENT NAME> are Word fields
38			and should NOT be manually changed. Instead they should be
39			changed by click File->Properties, where:
40
41			"Title" -> <SECTION NAME>
42			"Subject" -> <DOCUMENT NAME>
43
44			The "Title" and "Subject" fields should be used in ALL areas
45			where the name of the section or document are needed.
46
47			2)
48			All text should make use of "Styles". There should be NO
49			hardcoded text formatting in the document. If you wish to
50			change the appearance of a specific style you should change
51			the document template only.
52
53			3)
54			No changes should be made to the layout of the opening page,
55			the header or the footer. Again, all changes should be made
56			to the template only.
57
58			4)
59			All major changes to a document must have a full revision
60			entry on the opening page. This change must also be
61			verified by a nominated member of the team.
62
63			5)
64			The table of contents must be the first page after the
65			opening page (including any revsion history). This should
66			also NOT be manually edited for a specific document and
67			again, all changes should be made in the template file ONLY.
68
69			Notes :-
70
71			To ensure your document is using the latest template, update
72			CVS and click Tools->Templates and Add-ins then Attach. This
73			should ensure that all the latest template changes are
74			applied to your document.
75
76			All the above has been tried with Word 2000 only some
77			testing will need to be done to ensure that it is compatible
78			with Word 97.