White Space & Margins<\/h2>\r\nAlways make sure that a page has enough white space so that information does not look crammed onto the page. Readers tend not to read when there are large blocks of type. Look at the two figures below - just let your eye scan over the documents (reading the content does not matter).\u00a0 Based solely on the way each document looks, which one would you rather read?\r\n![\"Page](\"https:\/\/pressbooks.bccampus.ca\/technicalwriting\/wp-content\/uploads\/sites\/296\/2017\/12\/image1-3.png\")
Figure 1<\/strong> Excerpt from an Essay<\/em><\/figcaption><\/figure>\r\n<\/figure>\r\n![\"Excerpt](\"https:\/\/pressbooks.bccampus.ca\/technicalwriting\/wp-content\/uploads\/sites\/296\/2017\/12\/image2-3.png\")
Figure 2<\/strong>\u00a0Excerpt from a Technical Report<\/em><\/figcaption><\/figure>\r\nFollow these guidelines to use white space effectively, so that you have a \"clean\" looking, easy-to-read document:\r\n\r\n \t- Use margins of approximately 1 inch all around. (Note that if you are binding your report, use a 2 inch left margin.)<\/li>\r\n \t
- Break up lengthy paragraphs into short ones, so that you don't have large, difficult-to-read blocks of type.<\/li>\r\n \t
- Use headings to introduce sections of text.<\/li>\r\n \t
- Start all paragraphs on the left-hand margin; do not indent paragraphs.<\/li>\r\n \t
- Single-space your text, but leave a double space between paragraphs.<\/li>\r\n \t
- Align your text to your left-hand margin (called left-justifying), leaving a \"ragged\" right margin.\u00a0 Never<\/em><\/strong> justify both left- and right-hand margins, as this creates strange spacing of words and sentences that makes your text hard to read.<\/li>\r\n<\/ul>\r\n
Headings<\/h2>\r\nHeadings are standard features of technical documents that serve several important functions:\r\n\r\n \t- Provide organizational overview of the document<\/li>\r\n \t
- Show logical development of ideas<\/li>\r\n \t
- Show hierarchical relationship of ideas (headings, sub-headings)<\/li>\r\n \t
- Allow the reader to scan and read selectively<\/li>\r\n \t
- Increase readability of the document by providing breaks and white space.<\/li>\r\n<\/ul>\r\nWhen designing the headings in your document, keep in mind these general principles:\r\n
Hierarchical Relationship of Ideas<\/h3>\r\nUse font size, boldness, typography, and color to indicate the relative importance of ideas and how they interconnect. In general, first level headings are larger and bolder than second and subsequent level headings.\r\nConsistency<\/h3>\r\nIf you use headings, every section must have a heading. Make sure your headings at each level are consistent in design (font, size, color, etc.)\u00a0 Use consistent, parallel phrasing as well.\r\nReadability<\/h3>\r\nLeave white space above and below headings. There should always be slightly more space above the heading than below it. As a general guideline, use 2-4 headings per page in short reports. Avoid overusing headings. Note that if you use a heading, there should always be some text below it.\r\nSpecificity<\/h3>\r\nUse headings that directly and clearly inform the reader of the content of each section. For formal reports, descriptive headings are useful.\u00a0 Descriptive headings succinctly explain the content of each section.\u00a0 For proposals or other documents that have relatively consistent structures, use functional headings to clearly indicate each section.\u00a0 The figure below provides examples of functional and descriptive headings.\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Functional Headings - for Proposals\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Descriptive Headings - for Reports<\/strong>\r\n\r\n![\"the](\"https:\/\/pressbooks.bccampus.ca\/technicalwriting\/wp-content\/uploads\/sites\/296\/2017\/12\/function-vs-concrete-headings-1024x427.png\")
\r\nPlacement<\/h3>\r\nAvoid creating \u201cwidows and orphans\u201d\u00a0by leaving a heading at the bottom of the page with no body text below it. Insert a page break before your heading to avoid this.\r\nLists<\/h2>\r\nLists, when used correctly, are powerful tools to enhance readability.\u00a0 Lists allow you to emphasize important ideas, simplify long sentences or paragraphs, and help you add white space to make reading more pleasant.\r\n\r\nFollow these guidelines when creating lists of any kind:\r\n\r\n \t- Include\u00a0between 2-8 items in a list. You must have at least two items in a list (or it\u2019s not a list; it\u2019s just an item). Avoid having more than 8 items in a list, as too many items can have the reverse effect.\u00a0 If you emphasize too many ideas, you end up emphasizing nothing. NASA recommends no more than 8 steps in an emergency procedure; more than 8 can be overwhelming in a crisis situation.<\/li>\r\n \t
- Avoid splitting a list over two pages.<\/li>\r\n \t
- Set a list in context, with text that explains and\/or introduces the nature of the list.<\/li>\r\n \t
- Use\u00a0parallel phrasing for each listed item (note that each item in\u00a0this<\/em>\u00a0list starts with a verb).<\/li>\r\n<\/ul>\r\n
Common Types of Lists<\/h3>\r\nThere are five commonly used types of lists:\r\n\r\n \t- bulleted<\/li>\r\n \t
- numbered<\/li>\r\n \t
- in-sentence<\/li>\r\n \t
- labeled<\/li>\r\n \t
- nested<\/li>\r\n<\/ol>\r\n
Bulleted Lists<\/h4>\r\n
Bulleted lists are the most commonly used kind of list. They are effective when:<\/p>\r\n\r\n
\r\n \t- You want to emphasize two or more items<\/li>\r\n \t
- You can place the items in any order (no particular order is required)<\/li>\r\n \t
- You want to add white space to your document to enhance readability<\/li>\r\n<\/ul>\r\n
Bulleted list items should generally be short (a word or a phrase). If you find your bulleted items are longer than this, consider using another kind of list, such as a labeled list or a nested list.<\/p>\r\n\r\n
Numbered Lists<\/h4>\r\nUse numbered lists when the order of the listed items is important and ideas must be expressed in chronological order. For example, use a numbered list when you must provide a series of steps in instructions, or when you are introducing ideas that will be discussed in a certain order in the following text. If you have a list of more than approximately 8 items, consider breaking up the list in two or more stages or categories (Steps in Stage 1, Steps in Stage 2,\u00a0etc<\/em>.).\r\nIn-Sentence Lists<\/h4>\r\nUse in-sentence lists when you want to: a) maintain paragraph style, b) avoid having too many lists on one page, and c) keep the list items relatively short. The previous sentence is an example of an in-sentence list. Note that you can use a lower-case letter with a parenthesis after it to introduce each item.\u00a0 Sometimes in-sentence lists are combined with numbered lists if the list items are short and need to show a chronology.\r\nLabeled Lists<\/h4>\r\nUse a labeled list when you are listing items that need further explanation. Start the list item with the word or term (the \u201clabel\"), followed by a colon. Provide the brief explanation after the label, as part of the list item.\u00a0 Make sure the label portions (before the colon) are phrased consistently; try to make the explanations that follow roughly equal in length and detail. Labeled lists may also be bulleted or numbered.\r\n\r\nsample labeled lists<\/h3>\r\n
The project documentation consists of three main reports:<\/p>\r\n\r\n
\r\n \t- Report One<\/em>: an internal, informal proposal<\/li>\r\n \t
- Report Two<\/em>: an informative project plan<\/li>\r\n \t
- Report Three<\/em>: an final analysis of the project development, enactment, and implementation<\/li>\r\n<\/ol>\r\n \r\n
The project also includes requires two oral presentations:<\/p>\r\n\r\n
\r\n \t- Presentation 1: feasibility of project, presented to top management<\/li>\r\n \t
- Presentation 2: project kick-off, presented digitally to all employees<\/li>\r\n<\/ul>\r\n<\/div>\r\n
Nested Lists<\/h4>\r\n
A nested list is a list-within-a-list or a list with sub-listed items. Nested lists can be useful for avoiding overly long bulleted lists by categorizing items into sub-lists. Note the long bullet list on the left does not effectively categorize items, so emphasis is lost. The nested list is more effective.<\/p>\r\n \r\n
\r\n\r\n\r\nSimple Bullet List (too long)<\/strong><\/td>\r\nSample Nested List<\/strong><\/td>\r\n<\/tr>\r\n\r\n\r\nEvery restaurant should contain the following beverage containers:<\/p>\r\n\r\n
\r\n \t- Coffee cups\/mugs<\/li>\r\n \t
- Latte bowls<\/li>\r\n \t
- Tea cups<\/li>\r\n \t
- Travel mugs<\/li>\r\n \t
- Water glasses<\/li>\r\n \t
- Red Wine glasses<\/li>\r\n \t
- White wine glasses<\/li>\r\n \t
- Beer glasses<\/li>\r\n \t
- Beer steins<\/li>\r\n \t
- Cocktail glasses<\/li>\r\n \t
- Shot glasses<\/li>\r\n \t
- Reusable plastic cups.<\/li>\r\n<\/ul>\r\n
(12 items is too many for one list!)<\/em><\/p>\r\n<\/td>\r\n\r\nEvery restaurant should contain the following kinds of beverage containers:<\/p>\r\n\r\n
\r\n \t- \r\n
Hot beverage containers<\/p>\r\n\r\n
\r\n \t- Coffee mugs\/cups<\/li>\r\n \t
- Latte bowls<\/li>\r\n \t
- Tea cups<\/li>\r\n \t
- Travel mugs<\/li>\r\n<\/ul>\r\n<\/li>\r\n \t
- \r\n
Cold beverage containers<\/p>\r\n\r\n
\r\n \t- Water glasses<\/li>\r\n \t
- Red wine glasses<\/li>\r\n \t
- White wine glasses<\/li>\r\n \t
- Beer glasses<\/li>\r\n \t
- Beer steins<\/li>\r\n \t
- Cocktail glasses<\/li>\r\n \t
- Shot glasses<\/li>\r\n \t
- Reusable plastic cups.<\/li>\r\n<\/ul>\r\n<\/li>\r\n<\/ul>\r\n<\/td>\r\n<\/tr>\r\n<\/tbody>\r\n<\/table>\r\n
Figures & Tables<\/h2>\r\nLink to fuller information about creating and using visuals in the Using Visuals section of this text.\r\n\r\nWhen placing figures and tables within a document, good design requires that you label them with numbered captions that clearly identify and describe them.\u00a0 Figure captions are generally placed below the figures (images, graphs, etc.) while table captions are usually placed above the tables. This is because we generally read tables from the top down, and therefore want to see the caption at the top. On the other hand, figures are not always read top down - usually, when you see a figure, your eye goes to the image first, and then the caption, so it is placed below. If you prefer consistency in captioning, which is an option, then place both figure and table captions at the top consistently throughout your document.\r\n\r\n![\"\"](\"https:\/\/s3-us-west-2.amazonaws.com\/courses-images\/wp-content\/uploads\/sites\/4022\/2019\/06\/03203955\/5-300x200.jpg\")
\r\n\r\nLabel each figure or table with the word \"Figure\" or \"Table\" and a descriptive caption, and number them sequentially but separately, e.g., Table 1, Table 2, Table 3 and Figure 1, Figure 2, Figure 3.\r\n\r\nFinally, if you are using a table or figure from a source (not something that you created yourself), make sure to refer to that source in your caption, and document it, e.g., Figure 1. Network Design [1]<\/sup>.\u00a0 Include the full citation at the bottom of the page or, if there are many figures and tables, in a list at the end of the document.\r\n<\/h2>\r\nEmphasis<\/h2>\r\nThere are times when you will want to add emphasis to a word, phrase, or statistic so that it stands out from the surrounding text. The use of visual aids in your writing can be an excellent option, and can reinforce the written discussion. For example, if you write that sales are up 4% over this time last year, the number alone may not get the attention it deserves. If, however, near the text section you feature a bar graph showing sales growth, you reinforce the statistic.\r\n\r\nYou may also want to add emphasis with bold<\/strong>,\u00a0italics<\/em>, underlining<\/span>, highlights<\/span>, bullets, or other options such as different fonts. However, use these emphasis strategies sparingly, so that you really do make small pieces of information stand out and don't overwhelm your reader with too many special effects.\r\n<\/ol>\r\nFonts<\/h2>\r\nUsing an appropriate type font increases readability.\u00a0 There are two basic types of font, serif and sans serif:\r\n\r\n![\"Serif](\"https:\/\/s3-us-west-2.amazonaws.com\/courses-images\/wp-content\/uploads\/sites\/4022\/2019\/06\/04180143\/8-300x142.jpg\")
\r\n\r\nFollow these guidelines for fonts to enhance your document's readability:\r\n\r\n \t- Always use a standard font, such as Times New Roman or Calibri.\u00a0 Other fonts will be harder for your audience to read.<\/li>\r\n \t
- In most cases, use one main type of font throughout your document.\u00a0 If you want to mix fonts, then do not use more than two types in one document.<\/li>\r\n \t
- If you use two font types, the general practice is to use sans serif for headings and serif for the text.<\/li>\r\n \t
- Apply special effects sparingly, if at all.\u00a0 Confine effects to bold, italics, and underlining, but use these effects only if needed to highlight individual words or very small pieces of text.\u00a0 Overusing special effects will work against your need to highlight particular information.<\/li>\r\n \t
- Choose an appropriate type size.\u00a0 Most text should be in 12-pt. size, while headings would be larger (perhaps 16- pt. size, depending on the document) and often bold. Subheadings might be 14-pt. size, or they may be 12-pt. bold.<\/li>\r\n<\/ul>\r\n
Cover\/Title Page<\/h2>\r\nAlmost all formal reports have a Cover or Title Page, perhaps both. These two pages are used in nearly identical ways, yet some report types or organizations require both with a slight modification to the page\u2019s purpose.\r\n\r\nA cover page is a very simple, precise, brief way to introduce your report to the reader. This should contain:\r\n\r\n \t- A specific title in large font<\/li>\r\n \t
- Company name<\/li>\r\n \t
- Name of the author(s)<\/li>\r\n \t
- Date of the report<\/li>\r\n<\/ul>\r\nSometimes an image is included on the cover page, and sometimes it is not - it depends on your group or organization's format expectations as well as your own level of design expertise.\r\n\r\nA title page may be used as a cover page; it repeats the information on the cover, but may add more detail.\u00a0 Additional details that may be added on a title page include the following: report number if the report is part of a sequence, additional author information (e.g., titles, contact information), name and address of the supervisor, and the name and address of the organization that supported the report.\r\n\r\nHere are examples of cover and title pages; either one is fine for a formal report.\r\n\r\n\r\n
![\"Image](\"https:\/\/s3-us-west-2.amazonaws.com\/courses-images\/wp-content\/uploads\/sites\/2785\/2018\/03\/25204931\/Cover_TitlePage-1024x735.jpg\")
\r\n\r\n<\/div>\r\nTable of Contents<\/h2>\r\nThe table of contents is typically one of the last sections of the document to be created, since it relies on the body of the report. It provides a way of finding information in the report very quickly. In creating a table of contents, you have a number of design decisions:\r\n\r\n \t- Levels of headings to include<\/strong>: In longer reports, consider only including the top two levels of headings. This keeps the table of contents from becoming long and unwieldy.<\/li>\r\n \t
- Indentation, spacing, and capitalization<\/strong>: Notice in the sample that items in each of the three levels of headings are aligned with each other and page numbers are right-aligned with each other. Notice also the capitalization: Main chapters or sections are all caps; first-level headings use initial caps on each main word; lower-level sections use initial caps on the first word only.<\/li>\r\n \t
- Vertical spacing<\/strong>: Notice that the first-level sections have extra space above and below, which increases readability.<\/li>\r\n \t
- Wording<\/strong>: Make sure that the headings are worded exactly the same as they are in the text. As you write and revise, you might change some of the headings\u2014don\u2019t forget to change the table of contents accordingly.<\/li>\r\n<\/ul>\r\nNote that if you have a lot of figures and tables, you should also do a list of Figures & Tables after the table of contents.\u00a0 The same formatting and design characteristics apply.\r\n
Document Design Review<\/h2>\r\nView the following video to review major concepts of document design.\r\n\r\nhttps:\/\/www.youtube.com\/watch?v=OKBEx7N0vcg&t=42s\r\n\r\n ","rendered":"
![\"\"](\"https:\/\/s3-us-west-2.amazonaws.com\/courses-images\/wp-content\/uploads\/sites\/4022\/2019\/06\/03204413\/7-300x200.jpg\")
All documents have a purpose\u2014to persuade, inform, instruct\u2014but the first and foremost purpose of any document is to be\u00a0read<\/em><\/strong>. The way your document looks on a page or screen determines how fully and carefully your audience reads it.\u00a0 Good design will help your audience get the message you want them to receive and achieve your intended purpose. Remember that people do not read reports or proposals for pleasure; they read them because they have to – it’s part of their job. And since \u201ctime is money,\u201d the longer it takes to read the document, the higher the \u201ccost.\u201d When you design a document, your job is to make your audience’s reading process as easy, clear, and efficient as possible by using elements that make your document user friendly.<\/p>\nGeneral design elements to consider include the following:<\/p>\n
\n- White Space & Margins<\/li>\n
- Headings<\/li>\n
- Lists<\/li>\n
- Figures & Tables<\/li>\n
- Fonts<\/li>\n
- Cover\/Title Page<\/li>\n
- Table of Contents\/List of Figures<\/li>\n<\/ul>\n
White Space & Margins<\/h2>\n
Always make sure that a page has enough white space so that information does not look crammed onto the page. Readers tend not to read when there are large blocks of type. Look at the two figures below – just let your eye scan over the documents (reading the content does not matter).\u00a0 Based solely on the way each document looks, which one would you rather read?<\/p>\nFigure 1<\/strong> Excerpt from an Essay<\/em><\/figcaption><\/figure>\n<\/figure>\nFigure 2<\/strong>\u00a0Excerpt from a Technical Report<\/em><\/figcaption><\/figure>\nFollow these guidelines to use white space effectively, so that you have a “clean” looking, easy-to-read document:<\/p>\n
\n- Use margins of approximately 1 inch all around. (Note that if you are binding your report, use a 2 inch left margin.)<\/li>\n
- Break up lengthy paragraphs into short ones, so that you don’t have large, difficult-to-read blocks of type.<\/li>\n
- Use headings to introduce sections of text.<\/li>\n
- Start all paragraphs on the left-hand margin; do not indent paragraphs.<\/li>\n
- Single-space your text, but leave a double space between paragraphs.<\/li>\n
- Align your text to your left-hand margin (called left-justifying), leaving a “ragged” right margin.\u00a0 Never<\/em><\/strong> justify both left- and right-hand margins, as this creates strange spacing of words and sentences that makes your text hard to read.<\/li>\n<\/ul>\n
Headings<\/h2>\n
Headings are standard features of technical documents that serve several important functions:<\/p>\n
\n- Provide organizational overview of the document<\/li>\n
- Show logical development of ideas<\/li>\n
- Show hierarchical relationship of ideas (headings, sub-headings)<\/li>\n
- Allow the reader to scan and read selectively<\/li>\n
- Increase readability of the document by providing breaks and white space.<\/li>\n<\/ul>\n
When designing the headings in your document, keep in mind these general principles:<\/p>\n
Hierarchical Relationship of Ideas<\/h3>\n
Use font size, boldness, typography, and color to indicate the relative importance of ideas and how they interconnect. In general, first level headings are larger and bolder than second and subsequent level headings.<\/p>\n
Consistency<\/h3>\n
If you use headings, every section must have a heading. Make sure your headings at each level are consistent in design (font, size, color, etc.)\u00a0 Use consistent, parallel phrasing as well.<\/p>\n
Readability<\/h3>\n
Leave white space above and below headings. There should always be slightly more space above the heading than below it. As a general guideline, use 2-4 headings per page in short reports. Avoid overusing headings. Note that if you use a heading, there should always be some text below it.<\/p>\n
Specificity<\/h3>\n
Use headings that directly and clearly inform the reader of the content of each section. For formal reports, descriptive headings are useful.\u00a0 Descriptive headings succinctly explain the content of each section.\u00a0 For proposals or other documents that have relatively consistent structures, use functional headings to clearly indicate each section.\u00a0 The figure below provides examples of functional and descriptive headings.<\/p>\n
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Functional Headings – for Proposals\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Descriptive Headings – for Reports<\/strong><\/p>\n<\/p>\n
Placement<\/h3>\n
Avoid creating \u201cwidows and orphans\u201d\u00a0by leaving a heading at the bottom of the page with no body text below it. Insert a page break before your heading to avoid this.<\/p>\n
Lists<\/h2>\n
Lists, when used correctly, are powerful tools to enhance readability.\u00a0 Lists allow you to emphasize important ideas, simplify long sentences or paragraphs, and help you add white space to make reading more pleasant.<\/p>\n
Follow these guidelines when creating lists of any kind:<\/p>\n
\n- Include\u00a0between 2-8 items in a list. You must have at least two items in a list (or it\u2019s not a list; it\u2019s just an item). Avoid having more than 8 items in a list, as too many items can have the reverse effect.\u00a0 If you emphasize too many ideas, you end up emphasizing nothing. NASA recommends no more than 8 steps in an emergency procedure; more than 8 can be overwhelming in a crisis situation.<\/li>\n
- Avoid splitting a list over two pages.<\/li>\n
- Set a list in context, with text that explains and\/or introduces the nature of the list.<\/li>\n
- Use\u00a0parallel phrasing for each listed item (note that each item in\u00a0this<\/em>\u00a0list starts with a verb).<\/li>\n<\/ul>\n
Common Types of Lists<\/h3>\n
There are five commonly used types of lists:<\/p>\n
\n- bulleted<\/li>\n
- numbered<\/li>\n
- in-sentence<\/li>\n
- labeled<\/li>\n
- nested<\/li>\n<\/ol>\n
Bulleted Lists<\/h4>\n
Bulleted lists are the most commonly used kind of list. They are effective when:<\/p>\n
\n- You want to emphasize two or more items<\/li>\n
- You can place the items in any order (no particular order is required)<\/li>\n
- You want to add white space to your document to enhance readability<\/li>\n<\/ul>\n
Bulleted list items should generally be short (a word or a phrase). If you find your bulleted items are longer than this, consider using another kind of list, such as a labeled list or a nested list.<\/p>\n
Numbered Lists<\/h4>\n
Use numbered lists when the order of the listed items is important and ideas must be expressed in chronological order. For example, use a numbered list when you must provide a series of steps in instructions, or when you are introducing ideas that will be discussed in a certain order in the following text. If you have a list of more than approximately 8 items, consider breaking up the list in two or more stages or categories (Steps in Stage 1, Steps in Stage 2,\u00a0etc<\/em>.).<\/p>\nIn-Sentence Lists<\/h4>\n
Use in-sentence lists when you want to: a) maintain paragraph style, b) avoid having too many lists on one page, and c) keep the list items relatively short. The previous sentence is an example of an in-sentence list. Note that you can use a lower-case letter with a parenthesis after it to introduce each item.\u00a0 Sometimes in-sentence lists are combined with numbered lists if the list items are short and need to show a chronology.<\/p>\n
Labeled Lists<\/h4>\n
Use a labeled list when you are listing items that need further explanation. Start the list item with the word or term (the \u201clabel”), followed by a colon. Provide the brief explanation after the label, as part of the list item.\u00a0 Make sure the label portions (before the colon) are phrased consistently; try to make the explanations that follow roughly equal in length and detail. Labeled lists may also be bulleted or numbered.<\/p>\n
\nsample labeled lists<\/h3>\n
The project documentation consists of three main reports:<\/p>\n
\n- Report One<\/em>: an internal, informal proposal<\/li>\n
- Report Two<\/em>: an informative project plan<\/li>\n
- Report Three<\/em>: an final analysis of the project development, enactment, and implementation<\/li>\n<\/ol>\n
<\/p>\n
The project also includes requires two oral presentations:<\/p>\n
\n- Presentation 1: feasibility of project, presented to top management<\/li>\n
- Presentation 2: project kick-off, presented digitally to all employees<\/li>\n<\/ul>\n<\/div>\n
Nested Lists<\/h4>\n
A nested list is a list-within-a-list or a list with sub-listed items. Nested lists can be useful for avoiding overly long bulleted lists by categorizing items into sub-lists. Note the long bullet list on the left does not effectively categorize items, so emphasis is lost. The nested list is more effective.<\/p>\n
<\/p>\n
\n\n\nSimple Bullet List (too long)<\/strong><\/td>\nSample Nested List<\/strong><\/td>\n<\/tr>\n\n\nEvery restaurant should contain the following beverage containers:<\/p>\n
\n- Coffee cups\/mugs<\/li>\n
- Latte bowls<\/li>\n
- Tea cups<\/li>\n
- Travel mugs<\/li>\n
- Water glasses<\/li>\n
- Red Wine glasses<\/li>\n
- White wine glasses<\/li>\n
- Beer glasses<\/li>\n
- Beer steins<\/li>\n
- Cocktail glasses<\/li>\n
- Shot glasses<\/li>\n
- Reusable plastic cups.<\/li>\n<\/ul>\n
(12 items is too many for one list!)<\/em><\/p>\n<\/td>\n\nEvery restaurant should contain the following kinds of beverage containers:<\/p>\n
\n- \n
Hot beverage containers<\/p>\n
\n- Coffee mugs\/cups<\/li>\n
- Latte bowls<\/li>\n
- Tea cups<\/li>\n
- Travel mugs<\/li>\n<\/ul>\n<\/li>\n
- \n
Cold beverage containers<\/p>\n
\n- Water glasses<\/li>\n
- Red wine glasses<\/li>\n
- White wine glasses<\/li>\n
- Beer glasses<\/li>\n
- Beer steins<\/li>\n
- Cocktail glasses<\/li>\n
- Shot glasses<\/li>\n
- Reusable plastic cups.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Figures & Tables<\/h2>\n
Link to fuller information about creating and using visuals in the Using Visuals section of this text.<\/p>\n
When placing figures and tables within a document, good design requires that you label them with numbered captions that clearly identify and describe them.\u00a0 Figure captions are generally placed below the figures (images, graphs, etc.) while table captions are usually placed above the tables. This is because we generally read tables from the top down, and therefore want to see the caption at the top. On the other hand, figures are not always read top down – usually, when you see a figure, your eye goes to the image first, and then the caption, so it is placed below. If you prefer consistency in captioning, which is an option, then place both figure and table captions at the top consistently throughout your document.<\/p>\n
<\/p>\n
Label each figure or table with the word “Figure” or “Table” and a descriptive caption, and number them sequentially but separately, e.g., Table 1, Table 2, Table 3 and Figure 1, Figure 2, Figure 3.<\/p>\n
Finally, if you are using a table or figure from a source (not something that you created yourself), make sure to refer to that source in your caption, and document it, e.g., Figure 1. Network Design [1]<\/sup>.\u00a0 Include the full citation at the bottom of the page or, if there are many figures and tables, in a list at the end of the document.<\/p>\n<\/h2>\nEmphasis<\/h2>\n
There are times when you will want to add emphasis to a word, phrase, or statistic so that it stands out from the surrounding text. The use of visual aids in your writing can be an excellent option, and can reinforce the written discussion. For example, if you write that sales are up 4% over this time last year, the number alone may not get the attention it deserves. If, however, near the text section you feature a bar graph showing sales growth, you reinforce the statistic.<\/p>\n
You may also want to add emphasis with bold<\/strong>,\u00a0italics<\/em>, underlining<\/span>, highlights<\/span>, bullets, or other options such as different fonts. However, use these emphasis strategies sparingly, so that you really do make small pieces of information stand out and don’t overwhelm your reader with too many special effects.<\/p>\n<\/ol>\nFonts<\/h2>\n
Using an appropriate type font increases readability.\u00a0 There are two basic types of font, serif and sans serif:<\/p>\n
<\/p>\n
Follow these guidelines for fonts to enhance your document’s readability:<\/p>\n
\n- Always use a standard font, such as Times New Roman or Calibri.\u00a0 Other fonts will be harder for your audience to read.<\/li>\n
- In most cases, use one main type of font throughout your document.\u00a0 If you want to mix fonts, then do not use more than two types in one document.<\/li>\n
- If you use two font types, the general practice is to use sans serif for headings and serif for the text.<\/li>\n
- Apply special effects sparingly, if at all.\u00a0 Confine effects to bold, italics, and underlining, but use these effects only if needed to highlight individual words or very small pieces of text.\u00a0 Overusing special effects will work against your need to highlight particular information.<\/li>\n
- Choose an appropriate type size.\u00a0 Most text should be in 12-pt. size, while headings would be larger (perhaps 16- pt. size, depending on the document) and often bold. Subheadings might be 14-pt. size, or they may be 12-pt. bold.<\/li>\n<\/ul>\n
Cover\/Title Page<\/h2>\n
Almost all formal reports have a Cover or Title Page, perhaps both. These two pages are used in nearly identical ways, yet some report types or organizations require both with a slight modification to the page\u2019s purpose.<\/p>\n
A cover page is a very simple, precise, brief way to introduce your report to the reader. This should contain:<\/p>\n
\n- A specific title in large font<\/li>\n
- Company name<\/li>\n
- Name of the author(s)<\/li>\n
- Date of the report<\/li>\n<\/ul>\n
Sometimes an image is included on the cover page, and sometimes it is not – it depends on your group or organization’s format expectations as well as your own level of design expertise.<\/p>\n
A title page may be used as a cover page; it repeats the information on the cover, but may add more detail.\u00a0 Additional details that may be added on a title page include the following: report number if the report is part of a sequence, additional author information (e.g., titles, contact information), name and address of the supervisor, and the name and address of the organization that supported the report.<\/p>\n
Here are examples of cover and title pages; either one is fine for a formal report.<\/p>\n
\n<\/p>\n<\/div>\n
Table of Contents<\/h2>\n
The table of contents is typically one of the last sections of the document to be created, since it relies on the body of the report. It provides a way of finding information in the report very quickly. In creating a table of contents, you have a number of design decisions:<\/p>\n
\n- Levels of headings to include<\/strong>: In longer reports, consider only including the top two levels of headings. This keeps the table of contents from becoming long and unwieldy.<\/li>\n
- Indentation, spacing, and capitalization<\/strong>: Notice in the sample that items in each of the three levels of headings are aligned with each other and page numbers are right-aligned with each other. Notice also the capitalization: Main chapters or sections are all caps; first-level headings use initial caps on each main word; lower-level sections use initial caps on the first word only.<\/li>\n
- Vertical spacing<\/strong>: Notice that the first-level sections have extra space above and below, which increases readability.<\/li>\n
- Wording<\/strong>: Make sure that the headings are worded exactly the same as they are in the text. As you write and revise, you might change some of the headings\u2014don\u2019t forget to change the table of contents accordingly.<\/li>\n<\/ul>\n
Note that if you have a lot of figures and tables, you should also do a list of Figures & Tables after the table of contents.\u00a0 The same formatting and design characteristics apply.<\/p>\n
Document Design Review<\/h2>\n
View the following video to review major concepts of document design.<\/p>\n
- \r\n \t
- Use margins of approximately 1 inch all around. (Note that if you are binding your report, use a 2 inch left margin.)<\/li>\r\n \t
- Break up lengthy paragraphs into short ones, so that you don't have large, difficult-to-read blocks of type.<\/li>\r\n \t
- Use headings to introduce sections of text.<\/li>\r\n \t
- Start all paragraphs on the left-hand margin; do not indent paragraphs.<\/li>\r\n \t
- Single-space your text, but leave a double space between paragraphs.<\/li>\r\n \t
- Align your text to your left-hand margin (called left-justifying), leaving a \"ragged\" right margin.\u00a0 Never<\/em><\/strong> justify both left- and right-hand margins, as this creates strange spacing of words and sentences that makes your text hard to read.<\/li>\r\n<\/ul>\r\n
Headings<\/h2>\r\nHeadings are standard features of technical documents that serve several important functions:\r\n
- \r\n \t
- Provide organizational overview of the document<\/li>\r\n \t
- Show logical development of ideas<\/li>\r\n \t
- Show hierarchical relationship of ideas (headings, sub-headings)<\/li>\r\n \t
- Allow the reader to scan and read selectively<\/li>\r\n \t
- Increase readability of the document by providing breaks and white space.<\/li>\r\n<\/ul>\r\nWhen designing the headings in your document, keep in mind these general principles:\r\n
Hierarchical Relationship of Ideas<\/h3>\r\nUse font size, boldness, typography, and color to indicate the relative importance of ideas and how they interconnect. In general, first level headings are larger and bolder than second and subsequent level headings.\r\n
Consistency<\/h3>\r\nIf you use headings, every section must have a heading. Make sure your headings at each level are consistent in design (font, size, color, etc.)\u00a0 Use consistent, parallel phrasing as well.\r\n
Readability<\/h3>\r\nLeave white space above and below headings. There should always be slightly more space above the heading than below it. As a general guideline, use 2-4 headings per page in short reports. Avoid overusing headings. Note that if you use a heading, there should always be some text below it.\r\n
Specificity<\/h3>\r\nUse headings that directly and clearly inform the reader of the content of each section. For formal reports, descriptive headings are useful.\u00a0 Descriptive headings succinctly explain the content of each section.\u00a0 For proposals or other documents that have relatively consistent structures, use functional headings to clearly indicate each section.\u00a0 The figure below provides examples of functional and descriptive headings.\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Functional Headings - for Proposals\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Descriptive Headings - for Reports<\/strong>\r\n\r\n
\r\nPlacement<\/h3>\r\nAvoid creating \u201cwidows and orphans\u201d\u00a0by leaving a heading at the bottom of the page with no body text below it. Insert a page break before your heading to avoid this.\r\n
Lists<\/h2>\r\nLists, when used correctly, are powerful tools to enhance readability.\u00a0 Lists allow you to emphasize important ideas, simplify long sentences or paragraphs, and help you add white space to make reading more pleasant.\r\n\r\nFollow these guidelines when creating lists of any kind:\r\n
- \r\n \t
- Include\u00a0between 2-8 items in a list. You must have at least two items in a list (or it\u2019s not a list; it\u2019s just an item). Avoid having more than 8 items in a list, as too many items can have the reverse effect.\u00a0 If you emphasize too many ideas, you end up emphasizing nothing. NASA recommends no more than 8 steps in an emergency procedure; more than 8 can be overwhelming in a crisis situation.<\/li>\r\n \t
- Avoid splitting a list over two pages.<\/li>\r\n \t
- Set a list in context, with text that explains and\/or introduces the nature of the list.<\/li>\r\n \t
- Use\u00a0parallel phrasing for each listed item (note that each item in\u00a0this<\/em>\u00a0list starts with a verb).<\/li>\r\n<\/ul>\r\n
Common Types of Lists<\/h3>\r\nThere are five commonly used types of lists:\r\n
- \r\n \t
- bulleted<\/li>\r\n \t
- numbered<\/li>\r\n \t
- in-sentence<\/li>\r\n \t
- labeled<\/li>\r\n \t
- nested<\/li>\r\n<\/ol>\r\n
Bulleted Lists<\/h4>\r\n
Bulleted lists are the most commonly used kind of list. They are effective when:<\/p>\r\n\r\n
- \r\n \t
- You want to emphasize two or more items<\/li>\r\n \t
- You can place the items in any order (no particular order is required)<\/li>\r\n \t
- You want to add white space to your document to enhance readability<\/li>\r\n<\/ul>\r\n
Bulleted list items should generally be short (a word or a phrase). If you find your bulleted items are longer than this, consider using another kind of list, such as a labeled list or a nested list.<\/p>\r\n\r\n
Numbered Lists<\/h4>\r\nUse numbered lists when the order of the listed items is important and ideas must be expressed in chronological order. For example, use a numbered list when you must provide a series of steps in instructions, or when you are introducing ideas that will be discussed in a certain order in the following text. If you have a list of more than approximately 8 items, consider breaking up the list in two or more stages or categories (Steps in Stage 1, Steps in Stage 2,\u00a0etc<\/em>.).\r\n
In-Sentence Lists<\/h4>\r\nUse in-sentence lists when you want to: a) maintain paragraph style, b) avoid having too many lists on one page, and c) keep the list items relatively short. The previous sentence is an example of an in-sentence list. Note that you can use a lower-case letter with a parenthesis after it to introduce each item.\u00a0 Sometimes in-sentence lists are combined with numbered lists if the list items are short and need to show a chronology.\r\n
Labeled Lists<\/h4>\r\nUse a labeled list when you are listing items that need further explanation. Start the list item with the word or term (the \u201clabel\"), followed by a colon. Provide the brief explanation after the label, as part of the list item.\u00a0 Make sure the label portions (before the colon) are phrased consistently; try to make the explanations that follow roughly equal in length and detail. Labeled lists may also be bulleted or numbered.\r\n
\r\nsample labeled lists<\/h3>\r\n
The project documentation consists of three main reports:<\/p>\r\n\r\n
- \r\n \t
- Report One<\/em>: an internal, informal proposal<\/li>\r\n \t
- Report Two<\/em>: an informative project plan<\/li>\r\n \t
- Report Three<\/em>: an final analysis of the project development, enactment, and implementation<\/li>\r\n<\/ol>\r\n \r\n
The project also includes requires two oral presentations:<\/p>\r\n\r\n
- \r\n \t
- Presentation 1: feasibility of project, presented to top management<\/li>\r\n \t
- Presentation 2: project kick-off, presented digitally to all employees<\/li>\r\n<\/ul>\r\n<\/div>\r\n
Nested Lists<\/h4>\r\n
A nested list is a list-within-a-list or a list with sub-listed items. Nested lists can be useful for avoiding overly long bulleted lists by categorizing items into sub-lists. Note the long bullet list on the left does not effectively categorize items, so emphasis is lost. The nested list is more effective.<\/p>\r\n \r\n
\r\n\r\n
\r\n Simple Bullet List (too long)<\/strong><\/td>\r\n Sample Nested List<\/strong><\/td>\r\n<\/tr>\r\n \r\n \r\n Every restaurant should contain the following beverage containers:<\/p>\r\n\r\n
- \r\n \t
- Coffee cups\/mugs<\/li>\r\n \t
- Latte bowls<\/li>\r\n \t
- Tea cups<\/li>\r\n \t
- Travel mugs<\/li>\r\n \t
- Water glasses<\/li>\r\n \t
- Red Wine glasses<\/li>\r\n \t
- White wine glasses<\/li>\r\n \t
- Beer glasses<\/li>\r\n \t
- Beer steins<\/li>\r\n \t
- Cocktail glasses<\/li>\r\n \t
- Shot glasses<\/li>\r\n \t
- Reusable plastic cups.<\/li>\r\n<\/ul>\r\n
(12 items is too many for one list!)<\/em><\/p>\r\n<\/td>\r\n
\r\n Every restaurant should contain the following kinds of beverage containers:<\/p>\r\n\r\n
- \r\n \t
- \r\n
Hot beverage containers<\/p>\r\n\r\n
- \r\n \t
- Coffee mugs\/cups<\/li>\r\n \t
- Latte bowls<\/li>\r\n \t
- Tea cups<\/li>\r\n \t
- Travel mugs<\/li>\r\n<\/ul>\r\n<\/li>\r\n \t
- \r\n
Cold beverage containers<\/p>\r\n\r\n
- \r\n \t
- Water glasses<\/li>\r\n \t
- Red wine glasses<\/li>\r\n \t
- White wine glasses<\/li>\r\n \t
- Beer glasses<\/li>\r\n \t
- Beer steins<\/li>\r\n \t
- Cocktail glasses<\/li>\r\n \t
- Shot glasses<\/li>\r\n \t
- Reusable plastic cups.<\/li>\r\n<\/ul>\r\n<\/li>\r\n<\/ul>\r\n<\/td>\r\n<\/tr>\r\n<\/tbody>\r\n<\/table>\r\n
Figures & Tables<\/h2>\r\nLink to fuller information about creating and using visuals in the Using Visuals section of this text.\r\n\r\nWhen placing figures and tables within a document, good design requires that you label them with numbered captions that clearly identify and describe them.\u00a0 Figure captions are generally placed below the figures (images, graphs, etc.) while table captions are usually placed above the tables. This is because we generally read tables from the top down, and therefore want to see the caption at the top. On the other hand, figures are not always read top down - usually, when you see a figure, your eye goes to the image first, and then the caption, so it is placed below. If you prefer consistency in captioning, which is an option, then place both figure and table captions at the top consistently throughout your document.\r\n\r\n
\r\n\r\nLabel each figure or table with the word \"Figure\" or \"Table\" and a descriptive caption, and number them sequentially but separately, e.g., Table 1, Table 2, Table 3 and Figure 1, Figure 2, Figure 3.\r\n\r\nFinally, if you are using a table or figure from a source (not something that you created yourself), make sure to refer to that source in your caption, and document it, e.g., Figure 1. Network Design [1]<\/sup>.\u00a0 Include the full citation at the bottom of the page or, if there are many figures and tables, in a list at the end of the document.\r\n<\/h2>\r\n
Emphasis<\/h2>\r\nThere are times when you will want to add emphasis to a word, phrase, or statistic so that it stands out from the surrounding text. The use of visual aids in your writing can be an excellent option, and can reinforce the written discussion. For example, if you write that sales are up 4% over this time last year, the number alone may not get the attention it deserves. If, however, near the text section you feature a bar graph showing sales growth, you reinforce the statistic.\r\n\r\nYou may also want to add emphasis with bold<\/strong>,\u00a0italics<\/em>, underlining<\/span>, highlights<\/span>, bullets, or other options such as different fonts. However, use these emphasis strategies sparingly, so that you really do make small pieces of information stand out and don't overwhelm your reader with too many special effects.\r\n
- <\/ol>\r\n
- Always use a standard font, such as Times New Roman or Calibri.\u00a0 Other fonts will be harder for your audience to read.<\/li>\r\n \t
- In most cases, use one main type of font throughout your document.\u00a0 If you want to mix fonts, then do not use more than two types in one document.<\/li>\r\n \t
- If you use two font types, the general practice is to use sans serif for headings and serif for the text.<\/li>\r\n \t
- Apply special effects sparingly, if at all.\u00a0 Confine effects to bold, italics, and underlining, but use these effects only if needed to highlight individual words or very small pieces of text.\u00a0 Overusing special effects will work against your need to highlight particular information.<\/li>\r\n \t
- Choose an appropriate type size.\u00a0 Most text should be in 12-pt. size, while headings would be larger (perhaps 16- pt. size, depending on the document) and often bold. Subheadings might be 14-pt. size, or they may be 12-pt. bold.<\/li>\r\n<\/ul>\r\n
Cover\/Title Page<\/h2>\r\nAlmost all formal reports have a Cover or Title Page, perhaps both. These two pages are used in nearly identical ways, yet some report types or organizations require both with a slight modification to the page\u2019s purpose.\r\n\r\nA cover page is a very simple, precise, brief way to introduce your report to the reader. This should contain:\r\n
- \r\n \t
- A specific title in large font<\/li>\r\n \t
- Company name<\/li>\r\n \t
- Name of the author(s)<\/li>\r\n \t
- Date of the report<\/li>\r\n<\/ul>\r\nSometimes an image is included on the cover page, and sometimes it is not - it depends on your group or organization's format expectations as well as your own level of design expertise.\r\n\r\nA title page may be used as a cover page; it repeats the information on the cover, but may add more detail.\u00a0 Additional details that may be added on a title page include the following: report number if the report is part of a sequence, additional author information (e.g., titles, contact information), name and address of the supervisor, and the name and address of the organization that supported the report.\r\n\r\nHere are examples of cover and title pages; either one is fine for a formal report.\r\n\r\n\r\n\r\n\r\n<\/div>\r\n
Table of Contents<\/h2>\r\nThe table of contents is typically one of the last sections of the document to be created, since it relies on the body of the report. It provides a way of finding information in the report very quickly. In creating a table of contents, you have a number of design decisions:\r\n
- \r\n \t
- Levels of headings to include<\/strong>: In longer reports, consider only including the top two levels of headings. This keeps the table of contents from becoming long and unwieldy.<\/li>\r\n \t
- Indentation, spacing, and capitalization<\/strong>: Notice in the sample that items in each of the three levels of headings are aligned with each other and page numbers are right-aligned with each other. Notice also the capitalization: Main chapters or sections are all caps; first-level headings use initial caps on each main word; lower-level sections use initial caps on the first word only.<\/li>\r\n \t
- Vertical spacing<\/strong>: Notice that the first-level sections have extra space above and below, which increases readability.<\/li>\r\n \t
- Wording<\/strong>: Make sure that the headings are worded exactly the same as they are in the text. As you write and revise, you might change some of the headings\u2014don\u2019t forget to change the table of contents accordingly.<\/li>\r\n<\/ul>\r\nNote that if you have a lot of figures and tables, you should also do a list of Figures & Tables after the table of contents.\u00a0 The same formatting and design characteristics apply.\r\n
Document Design Review<\/h2>\r\nView the following video to review major concepts of document design.\r\n\r\nhttps:\/\/www.youtube.com\/watch?v=OKBEx7N0vcg&t=42s\r\n\r\n ","rendered":"
All documents have a purpose\u2014to persuade, inform, instruct\u2014but the first and foremost purpose of any document is to be\u00a0read<\/em><\/strong>. The way your document looks on a page or screen determines how fully and carefully your audience reads it.\u00a0 Good design will help your audience get the message you want them to receive and achieve your intended purpose. Remember that people do not read reports or proposals for pleasure; they read them because they have to – it’s part of their job. And since \u201ctime is money,\u201d the longer it takes to read the document, the higher the \u201ccost.\u201d When you design a document, your job is to make your audience’s reading process as easy, clear, and efficient as possible by using elements that make your document user friendly.<\/p>\nGeneral design elements to consider include the following:<\/p>\n
- \n
- White Space & Margins<\/li>\n
- Headings<\/li>\n
- Lists<\/li>\n
- Figures & Tables<\/li>\n
- Fonts<\/li>\n
- Cover\/Title Page<\/li>\n
- Table of Contents\/List of Figures<\/li>\n<\/ul>\n
White Space & Margins<\/h2>\n
Always make sure that a page has enough white space so that information does not look crammed onto the page. Readers tend not to read when there are large blocks of type. Look at the two figures below – just let your eye scan over the documents (reading the content does not matter).\u00a0 Based solely on the way each document looks, which one would you rather read?<\/p>\n
Figure 1<\/strong> Excerpt from an Essay<\/em><\/figcaption><\/figure>\n <\/figure>\nFigure 2<\/strong>\u00a0Excerpt from a Technical Report<\/em><\/figcaption><\/figure>\n Follow these guidelines to use white space effectively, so that you have a “clean” looking, easy-to-read document:<\/p>\n
- \n
- Use margins of approximately 1 inch all around. (Note that if you are binding your report, use a 2 inch left margin.)<\/li>\n
- Break up lengthy paragraphs into short ones, so that you don’t have large, difficult-to-read blocks of type.<\/li>\n
- Use headings to introduce sections of text.<\/li>\n
- Start all paragraphs on the left-hand margin; do not indent paragraphs.<\/li>\n
- Single-space your text, but leave a double space between paragraphs.<\/li>\n
- Align your text to your left-hand margin (called left-justifying), leaving a “ragged” right margin.\u00a0 Never<\/em><\/strong> justify both left- and right-hand margins, as this creates strange spacing of words and sentences that makes your text hard to read.<\/li>\n<\/ul>\n
Headings<\/h2>\n
Headings are standard features of technical documents that serve several important functions:<\/p>\n
- \n
- Provide organizational overview of the document<\/li>\n
- Show logical development of ideas<\/li>\n
- Show hierarchical relationship of ideas (headings, sub-headings)<\/li>\n
- Allow the reader to scan and read selectively<\/li>\n
- Increase readability of the document by providing breaks and white space.<\/li>\n<\/ul>\n
When designing the headings in your document, keep in mind these general principles:<\/p>\n
Hierarchical Relationship of Ideas<\/h3>\n
Use font size, boldness, typography, and color to indicate the relative importance of ideas and how they interconnect. In general, first level headings are larger and bolder than second and subsequent level headings.<\/p>\n
Consistency<\/h3>\n
If you use headings, every section must have a heading. Make sure your headings at each level are consistent in design (font, size, color, etc.)\u00a0 Use consistent, parallel phrasing as well.<\/p>\n
Readability<\/h3>\n
Leave white space above and below headings. There should always be slightly more space above the heading than below it. As a general guideline, use 2-4 headings per page in short reports. Avoid overusing headings. Note that if you use a heading, there should always be some text below it.<\/p>\n
Specificity<\/h3>\n
Use headings that directly and clearly inform the reader of the content of each section. For formal reports, descriptive headings are useful.\u00a0 Descriptive headings succinctly explain the content of each section.\u00a0 For proposals or other documents that have relatively consistent structures, use functional headings to clearly indicate each section.\u00a0 The figure below provides examples of functional and descriptive headings.<\/p>\n
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Functional Headings – for Proposals\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Descriptive Headings – for Reports<\/strong><\/p>\n
<\/p>\nPlacement<\/h3>\n
Avoid creating \u201cwidows and orphans\u201d\u00a0by leaving a heading at the bottom of the page with no body text below it. Insert a page break before your heading to avoid this.<\/p>\n
Lists<\/h2>\n
Lists, when used correctly, are powerful tools to enhance readability.\u00a0 Lists allow you to emphasize important ideas, simplify long sentences or paragraphs, and help you add white space to make reading more pleasant.<\/p>\n
Follow these guidelines when creating lists of any kind:<\/p>\n
- \n
- Include\u00a0between 2-8 items in a list. You must have at least two items in a list (or it\u2019s not a list; it\u2019s just an item). Avoid having more than 8 items in a list, as too many items can have the reverse effect.\u00a0 If you emphasize too many ideas, you end up emphasizing nothing. NASA recommends no more than 8 steps in an emergency procedure; more than 8 can be overwhelming in a crisis situation.<\/li>\n
- Avoid splitting a list over two pages.<\/li>\n
- Set a list in context, with text that explains and\/or introduces the nature of the list.<\/li>\n
- Use\u00a0parallel phrasing for each listed item (note that each item in\u00a0this<\/em>\u00a0list starts with a verb).<\/li>\n<\/ul>\n
Common Types of Lists<\/h3>\n
There are five commonly used types of lists:<\/p>\n
- \n
- bulleted<\/li>\n
- numbered<\/li>\n
- in-sentence<\/li>\n
- labeled<\/li>\n
- nested<\/li>\n<\/ol>\n
Bulleted Lists<\/h4>\n
Bulleted lists are the most commonly used kind of list. They are effective when:<\/p>\n
- \n
- You want to emphasize two or more items<\/li>\n
- You can place the items in any order (no particular order is required)<\/li>\n
- You want to add white space to your document to enhance readability<\/li>\n<\/ul>\n
Bulleted list items should generally be short (a word or a phrase). If you find your bulleted items are longer than this, consider using another kind of list, such as a labeled list or a nested list.<\/p>\n
Numbered Lists<\/h4>\n
Use numbered lists when the order of the listed items is important and ideas must be expressed in chronological order. For example, use a numbered list when you must provide a series of steps in instructions, or when you are introducing ideas that will be discussed in a certain order in the following text. If you have a list of more than approximately 8 items, consider breaking up the list in two or more stages or categories (Steps in Stage 1, Steps in Stage 2,\u00a0etc<\/em>.).<\/p>\n
In-Sentence Lists<\/h4>\n
Use in-sentence lists when you want to: a) maintain paragraph style, b) avoid having too many lists on one page, and c) keep the list items relatively short. The previous sentence is an example of an in-sentence list. Note that you can use a lower-case letter with a parenthesis after it to introduce each item.\u00a0 Sometimes in-sentence lists are combined with numbered lists if the list items are short and need to show a chronology.<\/p>\n
Labeled Lists<\/h4>\n
Use a labeled list when you are listing items that need further explanation. Start the list item with the word or term (the \u201clabel”), followed by a colon. Provide the brief explanation after the label, as part of the list item.\u00a0 Make sure the label portions (before the colon) are phrased consistently; try to make the explanations that follow roughly equal in length and detail. Labeled lists may also be bulleted or numbered.<\/p>\n
\nsample labeled lists<\/h3>\n
The project documentation consists of three main reports:<\/p>\n
- \n
- Report One<\/em>: an internal, informal proposal<\/li>\n
- Report Two<\/em>: an informative project plan<\/li>\n
- Report Three<\/em>: an final analysis of the project development, enactment, and implementation<\/li>\n<\/ol>\n
<\/p>\n
The project also includes requires two oral presentations:<\/p>\n
- \n
- Presentation 1: feasibility of project, presented to top management<\/li>\n
- Presentation 2: project kick-off, presented digitally to all employees<\/li>\n<\/ul>\n<\/div>\n
Nested Lists<\/h4>\n
A nested list is a list-within-a-list or a list with sub-listed items. Nested lists can be useful for avoiding overly long bulleted lists by categorizing items into sub-lists. Note the long bullet list on the left does not effectively categorize items, so emphasis is lost. The nested list is more effective.<\/p>\n
<\/p>\n
\n\n
\n Simple Bullet List (too long)<\/strong><\/td>\n Sample Nested List<\/strong><\/td>\n<\/tr>\n \n \n Every restaurant should contain the following beverage containers:<\/p>\n
- \n
- Coffee cups\/mugs<\/li>\n
- Latte bowls<\/li>\n
- Tea cups<\/li>\n
- Travel mugs<\/li>\n
- Water glasses<\/li>\n
- Red Wine glasses<\/li>\n
- White wine glasses<\/li>\n
- Beer glasses<\/li>\n
- Beer steins<\/li>\n
- Cocktail glasses<\/li>\n
- Shot glasses<\/li>\n
- Reusable plastic cups.<\/li>\n<\/ul>\n
(12 items is too many for one list!)<\/em><\/p>\n<\/td>\n
\n Every restaurant should contain the following kinds of beverage containers:<\/p>\n
- \n
- \n
Hot beverage containers<\/p>\n
- \n
- Coffee mugs\/cups<\/li>\n
- Latte bowls<\/li>\n
- Tea cups<\/li>\n
- Travel mugs<\/li>\n<\/ul>\n<\/li>\n
- \n
Cold beverage containers<\/p>\n
- \n
- Water glasses<\/li>\n
- Red wine glasses<\/li>\n
- White wine glasses<\/li>\n
- Beer glasses<\/li>\n
- Beer steins<\/li>\n
- Cocktail glasses<\/li>\n
- Shot glasses<\/li>\n
- Reusable plastic cups.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Figures & Tables<\/h2>\n
Link to fuller information about creating and using visuals in the Using Visuals section of this text.<\/p>\n
When placing figures and tables within a document, good design requires that you label them with numbered captions that clearly identify and describe them.\u00a0 Figure captions are generally placed below the figures (images, graphs, etc.) while table captions are usually placed above the tables. This is because we generally read tables from the top down, and therefore want to see the caption at the top. On the other hand, figures are not always read top down – usually, when you see a figure, your eye goes to the image first, and then the caption, so it is placed below. If you prefer consistency in captioning, which is an option, then place both figure and table captions at the top consistently throughout your document.<\/p>\n
<\/p>\nLabel each figure or table with the word “Figure” or “Table” and a descriptive caption, and number them sequentially but separately, e.g., Table 1, Table 2, Table 3 and Figure 1, Figure 2, Figure 3.<\/p>\n
Finally, if you are using a table or figure from a source (not something that you created yourself), make sure to refer to that source in your caption, and document it, e.g., Figure 1. Network Design [1]<\/sup>.\u00a0 Include the full citation at the bottom of the page or, if there are many figures and tables, in a list at the end of the document.<\/p>\n
<\/h2>\n
Emphasis<\/h2>\n
There are times when you will want to add emphasis to a word, phrase, or statistic so that it stands out from the surrounding text. The use of visual aids in your writing can be an excellent option, and can reinforce the written discussion. For example, if you write that sales are up 4% over this time last year, the number alone may not get the attention it deserves. If, however, near the text section you feature a bar graph showing sales growth, you reinforce the statistic.<\/p>\n
You may also want to add emphasis with bold<\/strong>,\u00a0italics<\/em>, underlining<\/span>, highlights<\/span>, bullets, or other options such as different fonts. However, use these emphasis strategies sparingly, so that you really do make small pieces of information stand out and don’t overwhelm your reader with too many special effects.<\/p>\n
- <\/ol>\n
- Always use a standard font, such as Times New Roman or Calibri.\u00a0 Other fonts will be harder for your audience to read.<\/li>\n
- In most cases, use one main type of font throughout your document.\u00a0 If you want to mix fonts, then do not use more than two types in one document.<\/li>\n
- If you use two font types, the general practice is to use sans serif for headings and serif for the text.<\/li>\n
- Apply special effects sparingly, if at all.\u00a0 Confine effects to bold, italics, and underlining, but use these effects only if needed to highlight individual words or very small pieces of text.\u00a0 Overusing special effects will work against your need to highlight particular information.<\/li>\n
- Choose an appropriate type size.\u00a0 Most text should be in 12-pt. size, while headings would be larger (perhaps 16- pt. size, depending on the document) and often bold. Subheadings might be 14-pt. size, or they may be 12-pt. bold.<\/li>\n<\/ul>\n
Cover\/Title Page<\/h2>\n
Almost all formal reports have a Cover or Title Page, perhaps both. These two pages are used in nearly identical ways, yet some report types or organizations require both with a slight modification to the page\u2019s purpose.<\/p>\n
A cover page is a very simple, precise, brief way to introduce your report to the reader. This should contain:<\/p>\n
- \n
- A specific title in large font<\/li>\n
- Company name<\/li>\n
- Name of the author(s)<\/li>\n
- Date of the report<\/li>\n<\/ul>\n
Sometimes an image is included on the cover page, and sometimes it is not – it depends on your group or organization’s format expectations as well as your own level of design expertise.<\/p>\n
A title page may be used as a cover page; it repeats the information on the cover, but may add more detail.\u00a0 Additional details that may be added on a title page include the following: report number if the report is part of a sequence, additional author information (e.g., titles, contact information), name and address of the supervisor, and the name and address of the organization that supported the report.<\/p>\n
Here are examples of cover and title pages; either one is fine for a formal report.<\/p>\n
\n<\/p>\n<\/div>\nTable of Contents<\/h2>\n
The table of contents is typically one of the last sections of the document to be created, since it relies on the body of the report. It provides a way of finding information in the report very quickly. In creating a table of contents, you have a number of design decisions:<\/p>\n
- \n
- Levels of headings to include<\/strong>: In longer reports, consider only including the top two levels of headings. This keeps the table of contents from becoming long and unwieldy.<\/li>\n
- Indentation, spacing, and capitalization<\/strong>: Notice in the sample that items in each of the three levels of headings are aligned with each other and page numbers are right-aligned with each other. Notice also the capitalization: Main chapters or sections are all caps; first-level headings use initial caps on each main word; lower-level sections use initial caps on the first word only.<\/li>\n
- Vertical spacing<\/strong>: Notice that the first-level sections have extra space above and below, which increases readability.<\/li>\n
- Wording<\/strong>: Make sure that the headings are worded exactly the same as they are in the text. As you write and revise, you might change some of the headings\u2014don\u2019t forget to change the table of contents accordingly.<\/li>\n<\/ul>\n
Note that if you have a lot of figures and tables, you should also do a list of Figures & Tables after the table of contents.\u00a0 The same formatting and design characteristics apply.<\/p>\n
Document Design Review<\/h2>\n
View the following video to review major concepts of document design.<\/p>\n
- Indentation, spacing, and capitalization<\/strong>: Notice in the sample that items in each of the three levels of headings are aligned with each other and page numbers are right-aligned with each other. Notice also the capitalization: Main chapters or sections are all caps; first-level headings use initial caps on each main word; lower-level sections use initial caps on the first word only.<\/li>\n
- Levels of headings to include<\/strong>: In longer reports, consider only including the top two levels of headings. This keeps the table of contents from becoming long and unwieldy.<\/li>\n
Fonts<\/h2>\n
Using an appropriate type font increases readability.\u00a0 There are two basic types of font, serif and sans serif:<\/p>\n
<\/p>\nFollow these guidelines for fonts to enhance your document’s readability:<\/p>\n
- \n
- \n
- Report Two<\/em>: an informative project plan<\/li>\n
- Report One<\/em>: an internal, informal proposal<\/li>\n
- Indentation, spacing, and capitalization<\/strong>: Notice in the sample that items in each of the three levels of headings are aligned with each other and page numbers are right-aligned with each other. Notice also the capitalization: Main chapters or sections are all caps; first-level headings use initial caps on each main word; lower-level sections use initial caps on the first word only.<\/li>\r\n \t
- Levels of headings to include<\/strong>: In longer reports, consider only including the top two levels of headings. This keeps the table of contents from becoming long and unwieldy.<\/li>\r\n \t
Fonts<\/h2>\r\nUsing an appropriate type font increases readability.\u00a0 There are two basic types of font, serif and sans serif:\r\n\r\n
\r\n\r\nFollow these guidelines for fonts to enhance your document's readability:\r\n- \r\n \t
- \r\n
- Report Two<\/em>: an informative project plan<\/li>\r\n \t
- Report One<\/em>: an internal, informal proposal<\/li>\r\n \t