commit 31250e699f82cd9059cde9b2b335efe9386f39fd Author: Mark Claypool <claypool@cs.wpi.edu> Date: Tue Dec 19 15:35:13 2023 -0500 Updates diff --git a/dos-donts.md b/dos-donts.md index 9c8f58b..f65f173 100644 --- a/dos-donts.md +++ b/dos-donts.md @@ -1,6 +1,6 @@ --- pagetitle: Report "Dos" and "Don'ts" -version: 1.3 +version: 1.4 --- # Report "Dos" and "Don'ts" @@ -30,8 +30,10 @@ version: 1.3 the reference should be used once, after the first sentence. It is then implied that the following sentences are drawn from the reference, too. + ++ Be consistent in capitalization across sections headings and + captions. e.g., "Results of first trial run" versus "Results of + First Trial Run". Either is fine, just be *consistent*. -+ Avoid passive voice. -+ [Other tips](https://web.cs.wpi.edu/~dcb/writing-tips.html), - courtesy of professor David Brown ++ Avoid passive voice. commit 7787d8152422e4800210945e3e3826e84df99d50 Author: Mark Claypool <claypool@cs.wpi.edu> Date: Wed Aug 31 16:55:03 2022 -0400 Updates diff --git a/dos-donts.md b/dos-donts.md index ce3e58f..9c8f58b 100644 --- a/dos-donts.md +++ b/dos-donts.md @@ -1,9 +1,9 @@ --- -pagetitle: Report "Dos" and "Dont's" -version: 1.2 +pagetitle: Report "Dos" and "Don'ts" +version: 1.3 --- -# Report "Dos" and "Dont's" +# Report "Dos" and "Don'ts" + The final report must have a front page which conforms to a specific format. As a tip, start with a previous report and just change the @@ -33,5 +33,5 @@ version: 1.2 + Avoid passive voice. -+ Other tips courtesy of professor [David - Brown](https://web.cs.wpi.edu/~dcb/writing-tips.html) ++ [Other tips](https://web.cs.wpi.edu/~dcb/writing-tips.html), + courtesy of professor David Brown commit f350951d1694e85c8036de296cdeb7c6ce17d762 Author: Mark Claypool <claypool@cs.wpi.edu> Date: Tue Aug 23 11:30:16 2022 -0400 Updates diff --git a/dos-donts.md b/dos-donts.md index 8623160..ce3e58f 100644 --- a/dos-donts.md +++ b/dos-donts.md @@ -33,3 +33,5 @@ version: 1.2 + Avoid passive voice. ++ Other tips courtesy of professor [David + Brown](https://web.cs.wpi.edu/~dcb/writing-tips.html) commit a262d8201a5895c7251c935b937c58e2506228c5 Author: Mark Claypool <claypool@cs.wpi.edu> Date: Tue Aug 9 09:17:35 2022 -0400 Updates diff --git a/dos-donts.md b/dos-donts.md index b8212ee..8623160 100644 --- a/dos-donts.md +++ b/dos-donts.md @@ -1,19 +1,21 @@ --- -pagetitle: Report "Do's" and "Dont's" +pagetitle: Report "Dos" and "Dont's" version: 1.2 --- -# Report "Do's" and "Dont's" +# Report "Dos" and "Dont's" + The final report must have a front page which conforms to a specific - format. See any accepted report and just change the title, names, date - and advisor. + format. As a tip, start with a previous report and just change the + title, names, date and advisor. + Number all pages (roman numerals before chapter 1). Regular - (Arabic) numerals from start of chapter 1. + (Arabic) numerals from the start of chapter 1. + Number all sections and subsections. ++ Do not use casual writing or slang. + + Spell out all contractions. E.g., "do not" instead of "don't". + Spell out all acronyms at first use. E.g., "The Bottleneck Bandwidth @@ -28,4 +30,6 @@ version: 1.2 the reference should be used once, after the first sentence. It is then implied that the following sentences are drawn from the reference, too. - + ++ Avoid passive voice. + commit 0a3a035cc794a63af63c86c0c68decfdb2d808f2 Author: Mark Claypool <claypool@cs.wpi.edu> Date: Mon Aug 8 13:58:58 2022 -0400 Updates diff --git a/dos-donts.md b/dos-donts.md index 9a73cfc..b8212ee 100644 --- a/dos-donts.md +++ b/dos-donts.md @@ -1,8 +1,9 @@ -# Report General Writing Guidelines +--- +pagetitle: Report "Do's" and "Dont's" +version: 1.2 +--- -v1.0 - -## "Do's" and "Dont's" +# Report "Do's" and "Dont's" + The final report must have a front page which conforms to a specific format. See any accepted report and just change the title, names, date commit 27469b4b69803e1877ac1585bb185b85a38d8135 Author: Mark Claypool <claypool@cs.wpi.edu> Date: Wed Jan 26 08:08:45 2022 -0500 Updates diff --git a/dos-donts.md b/dos-donts.md index 26f6181..9a73cfc 100644 --- a/dos-donts.md +++ b/dos-donts.md @@ -1,4 +1,5 @@ # Report General Writing Guidelines + v1.0 ## "Do's" and "Dont's" commit d4128661ee0785908dc7548a8b4ee9b53509e7fe Author: Mark Claypool <claypool@cs.wpi.edu> Date: Tue Feb 25 06:22:58 2020 -0500 Updates diff --git a/dos-donts.md b/dos-donts.md index ed2f832..26f6181 100644 --- a/dos-donts.md +++ b/dos-donts.md @@ -18,24 +18,6 @@ v1.0 and Roundtrip time (BBR) protocol ...". After that, the acronym can be used. -+ All figures/tables must have figure numbers followed by a caption, - even if the caption is already written inside the figure. E.g. - "Figure 4: Results of first trial run." - -+ Each figure must be referred to at least once in the text, telling - the user what to look for in that figure. E.g. "Figure 4 shows...." - Capitalize "Figure" when referring to it by number (e.g., "The - results in Figure 3...") - -+ Make sure any screenshots and graphs have readable fonts, - particularly if they are shrunk to fit. As a guideline, the font in - the figure should be the same size or just slightly smaller than the - main text font. - -+ Use of colors in figures is encouraged, but all graphs should also - be readable in black and white. Using colors and also hash shading - can be effective. - + References with bracket style [] go before the period of the sentence they refer to. So "...lots of data [32]." not "... lots of data.[32]" commit 7cdea3c5c6d40ac74033cd0558bb21a290339dd9 Author: Mark Claypool <claypool@cs.wpi.edu> Date: Sat Feb 16 07:40:16 2019 -0500 Rename diff --git a/mistakes.md b/dos-donts.md similarity index 100% rename from mistakes.md rename to dos-donts.md commit a7f8202c3b85d9cb988067b774f736150d5023b2 Author: Mark Claypool <claypool@cs.wpi.edu> Date: Sat Feb 16 07:33:19 2019 -0500 Updates diff --git a/mistakes.md b/mistakes.md index f963211..ed2f832 100644 --- a/mistakes.md +++ b/mistakes.md @@ -1,10 +1,11 @@ -# MQP General Writing Guidelines +# Report General Writing Guidelines v1.0 ## "Do's" and "Dont's" -+ MQP must have a front page which conforms to a specific format. See - any accepted MQP and just change the title, names, date and advisor. ++ The final report must have a front page which conforms to a specific + format. See any accepted report and just change the title, names, date + and advisor. + Number all pages (roman numerals before chapter 1). Regular (Arabic) numerals from start of chapter 1. commit 1fb73636736f1b807a0c10ea32c7ef0e0a5415f3 Author: Mark Claypool <claypool@cs.wpi.edu> Date: Mon Feb 26 07:34:24 2018 -0500 Updated dir structure (and others) diff --git a/mistakes.md b/mistakes.md index ec0c651..f963211 100644 --- a/mistakes.md +++ b/mistakes.md @@ -1,7 +1,7 @@ # MQP General Writing Guidelines v1.0 -## Common Write-up Mistakes to Avoid +## "Do's" and "Dont's" + MQP must have a front page which conforms to a specific format. See any accepted MQP and just change the title, names, date and advisor. @@ -11,6 +11,12 @@ v1.0 + Number all sections and subsections. ++ Spell out all contractions. E.g., "do not" instead of "don't". + ++ Spell out all acronyms at first use. E.g., "The Bottleneck Bandwidth + and Roundtrip time (BBR) protocol ...". After that, the acronym + can be used. + + All figures/tables must have figure numbers followed by a caption, even if the caption is already written inside the figure. E.g. "Figure 4: Results of first trial run." @@ -37,3 +43,4 @@ v1.0 the reference should be used once, after the first sentence. It is then implied that the following sentences are drawn from the reference, too. + commit b79bb200fda9bfb225e95d36cb5a1dfc6bfc9f46 Author: Mark Claypool <claypool@cs.wpi.edu> Date: Sat Feb 24 09:05:55 2018 -0500 Updated, and started Back/RW diff --git a/mistakes.md b/mistakes.md index 2d2375a..ec0c651 100644 --- a/mistakes.md +++ b/mistakes.md @@ -13,16 +13,27 @@ v1.0 + All figures/tables must have figure numbers followed by a caption, even if the caption is already written inside the figure. E.g. - "Figure 4: Results of first trial run" + "Figure 4: Results of first trial run." + Each figure must be referred to at least once in the text, telling the user what to look for in that figure. E.g. "Figure 4 shows...." - + Capitalize "Figure" when referring to it by number (e.g., "The + results in Figure 3...") + + Make sure any screenshots and graphs have readable fonts, particularly if they are shrunk to fit. As a guideline, the font in the figure should be the same size or just slightly smaller than the main text font. + Use of colors in figures is encouraged, but all graphs should also - be readable in black and white. Using colors but also hash shading + be readable in black and white. Using colors and also hash shading can be effective. + ++ References with bracket style [] go before the period of the + sentence they refer to. So "...lots of data [32]." not "... lots of + data.[32]" + ++ When drawing upon a reference for multiple facts in one paragraph, + the reference should be used once, after the first sentence. It is + then implied that the following sentences are drawn from the + reference, too. commit c97ff59acd7ebe95708b2c988909b289356b55b3 Author: Mark Claypool <claypool@cs.wpi.edu> Date: Sat Feb 3 07:29:31 2018 -0500 Updates diff --git a/mistakes.md b/mistakes.md new file mode 100644 index 0000000..2d2375a --- /dev/null +++ b/mistakes.md @@ -0,0 +1,28 @@ +# MQP General Writing Guidelines +v1.0 + +## Common Write-up Mistakes to Avoid + ++ MQP must have a front page which conforms to a specific format. See + any accepted MQP and just change the title, names, date and advisor. + ++ Number all pages (roman numerals before chapter 1). Regular + (Arabic) numerals from start of chapter 1. + ++ Number all sections and subsections. + ++ All figures/tables must have figure numbers followed by a caption, + even if the caption is already written inside the figure. E.g. + "Figure 4: Results of first trial run" + ++ Each figure must be referred to at least once in the text, telling + the user what to look for in that figure. E.g. "Figure 4 shows...." + ++ Make sure any screenshots and graphs have readable fonts, + particularly if they are shrunk to fit. As a guideline, the font in + the figure should be the same size or just slightly smaller than the + main text font. + ++ Use of colors in figures is encouraged, but all graphs should also + be readable in black and white. Using colors but also hash shading + can be effective.