BUSN7024 Project Management Principles
Semester 2, 2010 – Major Assignment
Project Management Plan
<Project Name>
Author 1...
Team Number: <??>
By signing on Table 1 each member acknowledges his or her agreement with the
stated contribution to the ...
Writing Documentation That Works Document format (advisory - to be deleted)
Acknowledgment
Walter Fernandez is grateful to...
Writing Documentation That Works Document format (advisory - to be deleted)
Contents
Contents................................
Writing Documentation That Works Document format (advisory - to be deleted)
6. Project Cost Management.......................
Writing Documentation That Works Document format (advisory - to be deleted)
10.3. Qualitative Risk Analysis..................
Writing Documentation That Works Document format (advisory - to be deleted)
Tables
Table 1: Membership and Individual Cont...
Writing Documentation That Works Document format (advisory - to be deleted)
1. Executive Summary
<Introduce your essay by ...
Writing Documentation That Works Document format (advisory - to be deleted)
2. Project Introduction
<Define the topic of y...
Writing Documentation That Works Document format (advisory - to be deleted)
3. Project Integration Management
<Introduce t...
Writing Documentation That Works Document format (advisory - to be deleted)
4. Project Scope Management
<Introduce the top...
Writing Documentation That Works Document format (advisory - to be deleted)
4.6. <Other points>
<Include other issues or c...
Writing Documentation That Works Document format (advisory - to be deleted)
5. Project Time Management
<Introduce the topi...
Writing Documentation That Works Document format (advisory - to be deleted)
5.6. <Other points>
<Include other issues or c...
Writing Documentation That Works Document format (advisory - to be deleted)
6. Project Cost Management
<Introduce the topi...
Writing Documentation That Works Document format (advisory - to be deleted)
7. Project Quality Management
<Introduce the t...
Writing Documentation That Works Document format (advisory - to be deleted)
8. Project Human Resource Management
<Introduc...
Writing Documentation That Works Document format (advisory - to be deleted)
9. Project Communication Management
<Introduce...
Writing Documentation That Works Document format (advisory - to be deleted)
10. Project Risk Management
<Introduce the top...
Writing Documentation That Works Document format (advisory - to be deleted)
10.6. <Other points>
<Include other issues or ...
Writing Documentation That Works Document format (advisory - to be deleted)
11. Project Procurement Management
<Introduce ...
Writing Documentation That Works Document format (advisory - to be deleted)
11.6. Contract Closeout
11.6.1. <Subheading(s)...
Writing Documentation That Works Document format (advisory - to be deleted)
12. Conclusion
<
<length: not more than one pa...
Writing Documentation That Works Document format (advisory - to be deleted)
13. Appendix 1
<use as many appendices as nece...
Writing Documentation That Works Document format (advisory - to be deleted)
14. References
<use Harvard Style, see:
http:/...
Writing Documentation That Works Document format (advisory - to be deleted)
15. Document format (advisory - to be deleted)...
Writing Documentation That Works Document format (advisory - to be deleted)
15.3. Headings
Document headings should have t...
Writing Documentation That Works Document format (advisory - to be deleted)
15.6. Numbered lists
Numbered lists are used w...
Writing Documentation That Works Document format (advisory - to be deleted)
• The break is made after a vowel with the sec...
Upcoming SlideShare
Loading in …5
×

BUSN7024_Project Management Plan_Template

425 views

Published on

0 Comments
0 Likes
Statistics
Notes
  • Be the first to comment

  • Be the first to like this

No Downloads
Views
Total views
425
On SlideShare
0
From Embeds
0
Number of Embeds
2
Actions
Shares
0
Downloads
7
Comments
0
Likes
0
Embeds 0
No embeds

No notes for slide

BUSN7024_Project Management Plan_Template

  1. 1. BUSN7024 Project Management Principles Semester 2, 2010 – Major Assignment Project Management Plan <Project Name> Author 1, Author 2, Author 3, Author 4, Author 5 Author 6 <in alphabetical order> Word Count: <use Tools => Word Count from the MS Word menus state the total number of words in your report – make sure that no part of the document is highlighted when you use the Word Count tool> Due Date: TBA: E-copy: via email to walter.fernandez@anu.edu.au Paper copy: assignment box, ABIS School Office File Name: busn7024project-management-plantemplate2563.doc
  2. 2. Team Number: <??> By signing on Table 1 each member acknowledges his or her agreement with the stated contribution to the overall assignment made by each team member. Name Student No Contribution Signature <Maria Callas> <U999999> <A> Table 1: Membership and Individual Contribution. Use the following convention to state each member contribution to the total effort • A = very good contribution, the team member went above the expected participation level. • B = good contribution, the member participated as expected and was diligent in performing the assigned tasks. • C = less than satisfactory contribution, the member participation and contribution was less than the average for the team. • D = the member had minimal participation on the team effort, shown lack of commitment to the team and significantly increased other members’ workload. • E = the team member did not contribute at all to the team. The team shall discuss and agree on the contribution level for each team member. Your signature on Table 1 indicates your agreement with the assessment of contribution. A lack of signature will indicate dissatisfaction with the attribution. Please note, if half or less than half of the team sign the contribution assessment, a penalty of 5% will apply to the assignment’s mark. To encourage the teams to strive to perform as a team, penalties will be assigned to students that perform below the minimum expected level (see Table 2). Individual contribution to the team’s effort. Penalty to be applied to the assignment’s mark for the particular student A 0% B. 0% C 15% D 50% E 100% Table 2: Human Resources Mismanagement Penalties. This page is confidential and will NOT be seen by the class. The lecturer will delete this page before releasing the document for class access on the web site.>
  3. 3. Writing Documentation That Works Document format (advisory - to be deleted) Acknowledgment Walter Fernandez is grateful to the author of this template, David Tuffley, who generously allowed him to modify the template and to use it at ANU. Plagiarism ✍ Plagiarism will not be tolerated. It is the responsibility of the team to ensure that proper citation and quotation conventions are followed. Failure to observe this rule will result in a zero mark for the entire assignment, regardless of the magnitude of the infringement. Further action(s) might be considered on a case-by-case basis. i of of vii
  4. 4. Writing Documentation That Works Document format (advisory - to be deleted) Contents Contents..................................................................................................ii 1. Executive Summary............................................................................1 2. Project Introduction...........................................................................2 3. Project Integration Management.......................................................3 3.1. Project Plan Development.............................................................3 3.1.1. <Subheading(s) if you want to use them>..............................3 3.2. Project Plan Execution..................................................................3 3.2.1. <Subheading(s) if you want to use them>..............................3 3.3. Integrated Change Control...........................................................3 3.3.1. <Subheading(s) if you want to use them>..............................3 3.4. <Other points>...............................................................................3 4. Project Scope Management...............................................................4 4.1. Initiation..........................................................................................4 4.1.1. <Subheading(s) if required>...................................................4 4.2. Scope Planning.............................................................................4 4.2.1. <Subheading(s) if required >..................................................4 4.3. Scope Definition.............................................................................4 4.3.1. <Subheading(s) if required >..................................................4 4.4. Scope Verification..........................................................................4 4.4.1. <Subheading(s) if required >..................................................4 4.5. Scope Change Control..................................................................4 4.5.1. <Subheading(s) if required >..................................................4 4.6. <Other points>...............................................................................5 5. Project Time Management..................................................................6 5.1. Activity Definition...........................................................................6 5.1.1. <Subheading(s) if required>...................................................6 5.2. Activity Sequencing......................................................................6 5.2.1. <Subheading(s) if required >..................................................6 5.3. Activity Duration Estimating...........................................................6 5.3.1. <Subheading(s) if required >..................................................6 5.4. Schedule Development..................................................................6 5.4.1. <Subheading(s) if required >..................................................6 5.5. Schedule Control...........................................................................6 5.5.1. <Subheading(s) if required >..................................................6 5.6. <Other points>...............................................................................7 ii of of vii
  5. 5. Writing Documentation That Works Document format (advisory - to be deleted) 6. Project Cost Management..................................................................8 6.1. Resource Planning........................................................................8 6.1.1. <Subheading(s) if required>...................................................8 6.2. Cost Estimating.............................................................................8 6.2.1. <Subheading(s) if required >..................................................8 6.3. Cost Budgeting..............................................................................8 6.3.1. <Subheading(s) if required >..................................................8 6.4. Cost Control...................................................................................8 6.4.1. <Subheading(s) if required >..................................................8 6.5. <Other points>...............................................................................8 7. Project Quality Management..............................................................9 7.1. Quality Planning.............................................................................9 7.1.1. <Subheading(s) if required>...................................................9 7.2. Quality Assurance.........................................................................9 7.2.1. <Subheading(s) if required >..................................................9 7.3. Quality Control...............................................................................9 7.3.1. <Subheading(s) if required >..................................................9 7.4. <Other points>...............................................................................9 8. Project Human Resource Management..........................................10 8.1. Organizational Planning..............................................................10 8.1.1. <Subheading(s) if required>................................................10 8.2. Staff Acquisition..........................................................................10 8.2.1. <Subheading(s) if required >...............................................10 8.3. Team Development......................................................................10 8.3.1. <Subheading(s) if required >...............................................10 8.4. <Other points>.............................................................................10 9. Project Communication Management.............................................11 9.1. Communications Planning...........................................................11 9.1.1. <Subheading(s) if required>................................................11 9.2. Information Distribution...............................................................11 9.2.1. <Subheading(s) if required >...............................................11 9.3. Performance Reporting................................................................11 9.3.1. <Subheading(s) if required >...............................................11 9.4. Administrative Closure.................................................................11 9.4.1. <Subheading(s) if required >...............................................11 9.5. <Other points>.............................................................................11 10. Project Risk Management..............................................................12 10.1. Risk Management Planning.......................................................12 10.1.1. <Subheading(s) if required>..............................................12 10.2. Risk Identification ....................................................................12 10.2.1. <Subheading(s) if required >.............................................12 iii of of vii
  6. 6. Writing Documentation That Works Document format (advisory - to be deleted) 10.3. Qualitative Risk Analysis...........................................................12 10.3.1. <Subheading(s) if required >.............................................12 10.4. Quantitative Risk Analysis.........................................................12 10.4.1. <Subheading(s) if required >.............................................12 10.5. Risk Monitoring and Control......................................................12 10.5.1. <Subheading(s) if required >.............................................12 10.6. <Other points>...........................................................................13 11. Project Procurement Management................................................14 11.1. Procurement Planning...............................................................14 11.1.1. <Subheading(s) if required>..............................................14 11.2. Solicitation Planning ................................................................14 11.2.1. <Subheading(s) if required >.............................................14 11.3. Solicitation.................................................................................14 11.3.1. <Subheading(s) if required >.............................................14 11.4. Source Selection........................................................................14 11.4.1. <Subheading(s) if required >.............................................14 11.5. Contract Administration.............................................................14 11.5.1. <Subheading(s) if required >.............................................14 11.6. Contract Closeout......................................................................15 11.6.1. <Subheading(s) if required >.............................................15 11.7. <Other points>...........................................................................15 12. Conclusion.......................................................................................16 13. Appendix 1.......................................................................................17 14. References.......................................................................................18 15. Document format (advisory - to be deleted)..................................1 15.1. Table of contents.........................................................................1 15.2. Page size and margins................................................................1 15.3. Headings......................................................................................2 15.4. Body text......................................................................................2 15.5. Bullets..........................................................................................2 15.6. Numbered lists.............................................................................3 15.7. Figures & numerals......................................................................3 15.8. Justification..................................................................................3 15.9. Italics............................................................................................3 15.10. Emphasis...................................................................................3 15.11. Hyphenation...............................................................................3 15.12. Acronyms & jargon.....................................................................4 15.13. Widow/orphan protection...........................................................4 15.14. Paragraph numbering................................................................4 15.15. Other considerations.................................................................4 iv of of vii
  7. 7. Writing Documentation That Works Document format (advisory - to be deleted) Tables Table 1: Membership and Individual Contribution..............................b Table 2: Human Resources Mismanagement Penalties.....................b Figures Figure 1: Example - Manufacturing Clip...............................................2 v of of vii
  8. 8. Writing Documentation That Works Document format (advisory - to be deleted) 1. Executive Summary <Introduce your essay by stating what it is you are going to do, how you will accomplish it. The Introduction will be used to see whether the Body of the assignment achieves these objectives> <length: not more than one page – about 400 words> Page 1 of 18
  9. 9. Writing Documentation That Works Document format (advisory - to be deleted) 2. Project Introduction <Define the topic of your essay by stating its meaning and purpose, existing and future needs, problem that it addresses and why the topic is important. A good definition ensures that the reader understand the meaning as well as the importance of the topic> <length: not more than two pages – about 800 words> <if you use figures or tables, please follow the convencion shown in this template for captions and cross-referencing.> <To insert the caption on a figure or a table highlight the object then (=>) from the menu select Insert => Reference => Caption => select the appropriate label (figure in this case) and the position (below selected item). You could also right click on the figure and select the Caption option. Try that with Figure 1.> Figure 1: Example - Manufacturing Clip. <Please notice that references to Figure 1 are not hard-coded (not typed), rather they were inserted as a cross-reference.> <To insert a cross-reference you need to go to the main menu, select Insert => Reference => Cross-reference => then select the reference type [figure|table|etc.] and choose “only level and number” from the list of Insert reference to: (top right corner).> <By using captions and cross-references every time you insert a table or a figure you are automating your document and making it efficient and self-correcting.> Page 2 of 18
  10. 10. Writing Documentation That Works Document format (advisory - to be deleted) 3. Project Integration Management <Introduce the topic briefly > 3.1. Project Plan Development <length for each component: 500 - 1000 words> 3.1.1. <Subheading(s) if you want to use them> 3.2. Project Plan Execution 3.2.1. <Subheading(s) if you want to use them> 3.3. Integrated Change Control 3.3.1. <Subheading(s) if you want to use them> 3.4. <Other points> <Include other issues or considerations regarding this topic that you may have identified as part of your research and consider important to be highlighted> Page 3 of 18
  11. 11. Writing Documentation That Works Document format (advisory - to be deleted) 4. Project Scope Management <Introduce the topic briefly > 4.1. Initiation <length for each component: 500 - 1000 words> 4.1.1. <Subheading(s) if required> 4.2. Scope Planning 4.2.1. <Subheading(s) if required > 4.3. Scope Definition 4.3.1. <Subheading(s) if required > 4.4. Scope Verification 4.4.1. <Subheading(s) if required > 4.5. Scope Change Control 4.5.1. <Subheading(s) if required > Page 4 of 18
  12. 12. Writing Documentation That Works Document format (advisory - to be deleted) 4.6. <Other points> <Include other issues or considerations regarding this topic that you may have identified as part of your research and consider important to be highlighted> Page 5 of 18
  13. 13. Writing Documentation That Works Document format (advisory - to be deleted) 5. Project Time Management <Introduce the topic briefly > 5.1. Activity Definition <length for each component: 500 - 1000 words> 5.1.1. <Subheading(s) if required> 5.2. Activity Sequencing 5.2.1. <Subheading(s) if required > 5.3. Activity Duration Estimating 5.3.1. <Subheading(s) if required > 5.4. Schedule Development 5.4.1. <Subheading(s) if required > 5.5. Schedule Control 5.5.1. <Subheading(s) if required > Page 6 of 18
  14. 14. Writing Documentation That Works Document format (advisory - to be deleted) 5.6. <Other points> <Include other issues or considerations regarding this topic that you may have identified as part of your research and consider important to be highlighted> Page 7 of 18
  15. 15. Writing Documentation That Works Document format (advisory - to be deleted) 6. Project Cost Management <Introduce the topic briefly > 6.1. Resource Planning <length for each component: 500 - 1000 words> 6.1.1. <Subheading(s) if required> 6.2. Cost Estimating 6.2.1. <Subheading(s) if required > 6.3. Cost Budgeting 6.3.1. <Subheading(s) if required > 6.4. Cost Control 6.4.1. <Subheading(s) if required > 6.5. <Other points> <Include other issues or considerations regarding this topic that you may have identified as part of your research and consider important to be highlighted> Page 8 of 18
  16. 16. Writing Documentation That Works Document format (advisory - to be deleted) 7. Project Quality Management <Introduce the topic briefly > 7.1. Quality Planning <length for each component: 500 - 1000 words> 7.1.1. <Subheading(s) if required> 7.2. Quality Assurance 7.2.1. <Subheading(s) if required > 7.3. Quality Control 7.3.1. <Subheading(s) if required > 7.4. <Other points> <Include other issues or considerations regarding this topic that you may have identified as part of your research and consider important to be highlighted> Page 9 of 18
  17. 17. Writing Documentation That Works Document format (advisory - to be deleted) 8. Project Human Resource Management <Introduce the topic briefly > 8.1. Organizational Planning <length for each component: 500 - 1000 words> 8.1.1. <Subheading(s) if required> 8.2. Staff Acquisition 8.2.1. <Subheading(s) if required > 8.3. Team Development 8.3.1. <Subheading(s) if required > 8.4. <Other points> <Include other issues or considerations regarding this topic that you may have identified as part of your research and consider important to be highlighted> Page 10 of 18
  18. 18. Writing Documentation That Works Document format (advisory - to be deleted) 9. Project Communication Management <Introduce the topic briefly > 9.1. Communications Planning <length for each component: 500 - 1000 words> 9.1.1. <Subheading(s) if required> 9.2. Information Distribution 9.2.1. <Subheading(s) if required > 9.3. Performance Reporting 9.3.1. <Subheading(s) if required > 9.4. Administrative Closure 9.4.1. <Subheading(s) if required > 9.5. <Other points> <Include other issues or considerations regarding this topic that you may have identified as part of your research and consider important to be highlighted> Page 11 of 18
  19. 19. Writing Documentation That Works Document format (advisory - to be deleted) 10. Project Risk Management <Introduce the topic briefly > 10.1. Risk Management Planning <length for each component: 500 - 1000 words> 10.1.1. <Subheading(s) if required> 10.2. Risk Identification 10.2.1. <Subheading(s) if required > 10.3. Qualitative Risk Analysis 10.3.1. <Subheading(s) if required > 10.4. Quantitative Risk Analysis 10.4.1. <Subheading(s) if required > 10.5. Risk Monitoring and Control 10.5.1. <Subheading(s) if required > Page 12 of 18
  20. 20. Writing Documentation That Works Document format (advisory - to be deleted) 10.6. <Other points> <Include other issues or considerations regarding this topic that you may have identified as part of your research and consider important to be highlighted> Page 13 of 18
  21. 21. Writing Documentation That Works Document format (advisory - to be deleted) 11. Project Procurement Management <Introduce the topic briefly > 11.1. Procurement Planning <length for each component: 500 - 1000 words> 11.1.1. <Subheading(s) if required> 11.2. Solicitation Planning 11.2.1. <Subheading(s) if required > 11.3. Solicitation 11.3.1. <Subheading(s) if required > 11.4. Source Selection 11.4.1. <Subheading(s) if required > 11.5. Contract Administration 11.5.1. <Subheading(s) if required > Page 14 of 18
  22. 22. Writing Documentation That Works Document format (advisory - to be deleted) 11.6. Contract Closeout 11.6.1. <Subheading(s) if required > 11.7. <Other points> <Include other issues or considerations regarding this topic that you may have identified as part of your research and consider important to be highlighted> Page 15 of 18
  23. 23. Writing Documentation That Works Document format (advisory - to be deleted) 12. Conclusion < <length: not more than one page – about 400 words> Page 16 of 18
  24. 24. Writing Documentation That Works Document format (advisory - to be deleted) 13. Appendix 1 <use as many appendices as necessary, while this element is not examinable it may provide an indication of the quality of your work> Page 17 of 18
  25. 25. Writing Documentation That Works Document format (advisory - to be deleted) 14. References <use Harvard Style, see: http://www.lib.monash.edu.au/tutorials/citing/harvard.html > <For example: Groenewegen, D. (1997), The Real Thing?: The Rock Music Industry and the Creation of Australian Images, Moonlight Publishing, Golden Square, Victoria Blaxter, P. (1976), Social health and class inequalities, in: Carter, C. & Peel, J. (eds) Equalities and Inequalities in Health, 2nd ed, Academic Press, London Hudson, P. (1998, September 16 - last update), "PM, Costello liars: former bank chief", (The Age), Available: http://www.theage.com.au/daily/980916/news/news2.html (Accessed: 1998, September 16). <delete these examples from finished essay> Page 18 of 18
  26. 26. Writing Documentation That Works Document format (advisory - to be deleted) 15. Document format (advisory - to be deleted) This section outlines a uniform set of formatting standards which enable a reader to find the information they need with a minimum of time and effort. 15.1. Table of contents The document contents list is located after the cover sheet and should comply with the following: • Be titled “Contents” not “Table of contents”. • Contain the headings from the document broken down and arranged into a logical groupings. • Contain all headings up to but not exceeding level four headings. The document itself should have no more than four levels of headings. • Illustrations lists should be shown. • Appendix(es) should be shown. • Page numbers are given for each entry and are joined to the entry by a leader string (row of dots). • TOC text should use the following font attributes: Level Font Indent Size Space above/below toc 1 Arial bold 1.0 cm. 12 pt. 12/6 pts. toc 2 Arial 1.5 cm. 11 pt. 6/0 pts. toc 3 Arial 2.0 cm. 11 pt. 3/0 pts. toc 3 Arial 2.5 cm. 11 pt. 0/0 pts. • Level one TOC entry should have a narrow ruling line beneath. • Header/footer. If the document being produced does not have a table of contents, it is good practice to design the document before beginning work by making a list of the headings which will form the contents list. As a general guide, the organisation of a document should reflect a logical sequence, whether a chronological sequence, a progression from the general to the specific, or other meaningful sequence. 15.2. Page size and margins Page set-up should have the following attributes: • Page size - A4. • Margins (left & right) - 2.54 cm. • Margins (top & bottom) - 3.17 cm. • Header & footer - 1.25 cm in from edge. • Gutter - zero cm. Page 1
  27. 27. Writing Documentation That Works Document format (advisory - to be deleted) 15.3. Headings Document headings should have the following attributes: • No more than four levels of heading should be used. • Headings should be indented according to their level of significance in accordance with the following table. Level Style Font & Size Space above/below Ruling line Indent 1 Heading 1 Arial 18 pt bold 18/18 pts. 3 pt. 0 cm. 2 Heading 2 Arial 16 pt bold 10/12 pts. 1.5 pt. 1.25 cm. 3 Heading 3 Arial 14 pt bold 12/6 pts. - 2.5 cm. 4 Heading 4 Arial 12 pt bold 12/3 pts - 3.75 cm. Level one and two headings should have a ruling line beneath, as shown in the above table. The ruling lines should be 4 pts. beneath the text and extend from the beginning of the heading across to the right margin. All headings should have the first word capitalised and subsequent words in lower case. Proper nouns (i.e. Griffith University) have the first letter capitalised wherever they appear in a heading. ✍ Note: This guide specifies the use of Arial and Times Roman fonts since these are excellent general purpose fonts available on most computers. As a general rule, stick to these two fonts where possible. If unavailable use another similar font. Avoid the use of unusual or fancy fonts unless you have a specific need. 15.4. Body text The body text should have the following attributes: • Be left justified (i.e. aligned to the left, leaving a ragged right edge). • Times Roman (TT) 12 points. • Indented 3.75 cm from the left margin. • Space - zero points above and six points below. 15.5. Bullets Bullets are used for lists where the order is not important. Bullet points should have the following attributes: • Times Roman (TT) 11 points. • Indented 3.75 cm from the left margin so that bullet character is in line with body text. • Bullet character a 10 pt. filled dot. • Hanging indent of 0.5 cm from bullet character to start of text. • Space - zero points above and three points below. • Bullet points should only be used for lists of two or more points (i.e. no single bullet point). Page 2
  28. 28. Writing Documentation That Works Document format (advisory - to be deleted) 15.6. Numbered lists Numbered lists are used where the order is significant, such as in procedural steps. The attributes for a numbered list are the same as for bullet lists, with the substitution of Arabic numbers (i.e. 1, 2, 3) for bullet dots and a hanging indent of 0.75 cm after the number to accommodate double digits. 15.7. Figures & numerals Decimal numbers less than 10 shown as numbers (i.e. 6.5). Whole numbers less than 10 are spelt in full. Spaces are used for numbers with four or more figures (i.e. 10 000). 15.8. Justification Justification styles should be as follows: • All heading, body text and bulleted/numbered lists and captions left justified. • Table headings and table contents may be left, right or centred. 15.9. Italics Italics should be used for the following: • To add emphasis to words, phrases or sentences. • Foreign words (i.e. ad hoc). • Titles of publications (i.e. Concise Oxford Dictionary) 15.10. Emphasis Emphasis can be achieved in the following ways (in ascending order of emphasis): • Italics. • Bold Italics. • Callout character - as follows: ✍ Add emphasis to a paragraph with a callout character. Words within such a paragraph may be further emphasised with italics or bold italics. 15.11. Hyphenation Hyphenation is not obligatory. Many people prefer not to have body text hyphenated since it slightly increases the difficulty with which a reader scans a line, although the difficulty in many cases is negligible. Where done, hyphenation should be made as follows: Page 3
  29. 29. Writing Documentation That Works Document format (advisory - to be deleted) • The break is made after a vowel with the second part beginning with a consonant (i.e. peo-ple). • For multiple part words the practice of hyphenating words is decreasing, so as a general rule don’t hyphenate if in doubt. For example, cooperate multi tasking. • Fractions are hyphenated (i.e. two-thirds, five-eighths). Compound words like day-to-day task-sharing are hyphenated. Enable automatic hyphenation where this is available in your wordprocessor. 15.12. Acronyms & jargon While the use of acronyms and jargon can be justified in some cases, they should be avoided where possible. Where acronyms are used they should be defined in the definitions and acronyms section and also defined the first time they are used in each chapter. Only acronyms used in the current document are to appear in the definitions & acronyms section. 15.13. Widow/orphan protection A "widow" is the last line of a paragraph that appears alone at the top of a page. An "orphan" is the first line of a paragraph that appears alone at the bottom of a page. Use the widow/orphan protection option in your wordprocessor to prevent this occurring in the document. 15.14. Paragraph numbering While headings can be numbered, avoid paragraph numbering the body text unless there is a specific need to use it. 15.15. Other considerations Abbreviations - use fullstops with abbreviations and contractions. For example Fri. for Friday. Punctuation Spacing - one space only after any punctuation mark. Note: in some places the norm is to use two spaces after a full stop and one space after all other punctuation marks. Whichever rule you follow, you must be consistent. Page 4

×