commit 0a3a035cc794a63af63c86c0c68decfdb2d808f2 Author: Mark Claypool <claypool@cs.wpi.edu> Date: Mon Aug 8 13:58:58 2022 -0400 Updates diff --git a/introduction.md b/introduction.md index 4688b57..30505d3 100644 --- a/introduction.md +++ b/introduction.md @@ -1,9 +1,9 @@ --- -pagetitle: Introduction Guidelines -version: 1.12 +pagetitle: Writing the Introduction +version: 2.2 --- -# Introduction Guidelines +# Writing the Introduction The Introduction is perhaps the most important chapter in your report. commit 6820905c63360fc735bf604a944115ba04e1df6b Author: Mark Claypool <claypool@cs.wpi.edu> Date: Fri Aug 5 16:24:57 2022 -0400 Updates diff --git a/introduction.md b/introduction.md index 009ac31..4688b57 100644 --- a/introduction.md +++ b/introduction.md @@ -1,6 +1,9 @@ -# Introduction Writing Guidelines +--- +pagetitle: Introduction Guidelines +version: 1.12 +--- -v1.11 +# Introduction Guidelines The Introduction is perhaps the most important chapter in your report. @@ -14,22 +17,28 @@ Typically, the structure is: + Briefly mention solutions that attempt to meet those challenges -+ Carefully say why those solutions are not sufficient ++ Concisely say why those solutions are not sufficient -+ The previous paragraph sets up your *problem statement* +Note, the previous paragraphs set up your *problem statement*. -+ Describe the methods used to address the problem (think *verbs*) +Then: -+ Provide the results - what you ended up with (think *nouns*) ++ Describe the methods you used to address the problem (think *verbs*) -+ Last, give a "roadmap" (1 paragraph) on the layout for the rest of ++ Give a high-level summary of the results - what you ended up with +(think *nouns*) + +Lastly: + ++ Have a short "roadmap" (1 paragraph) on the layout for the rest of the report. e.g., "Chapter 2 provides background and related -technologies on ..." +technologies on ...; Chapter 3 describes ..." *Important*: All of the above needs to be readable, have flow, taking the reader from the broad to the narrow, providing an understanding of -why the domain and problem are important and giving a good idea of +why the domain and problem are important, and giving a good idea of what you did about the problem. -It is best to outline the introduction before writing it. Do this at -the paragraph level - think of topic sentences and supporting details. +It is best to outline the Introduction before writing it in order to +get the content and flow down. Do this at the paragraph level - think +of topic sentences and supporting details. commit f6bc4d07c2f4fb3fb5ccfbe4ac619be2899828cf Author: Mark Claypool <claypool@cs.wpi.edu> Date: Tue Oct 5 16:35:03 2021 -0400 Updates diff --git a/introduction.md b/introduction.md index a40e8ef..009ac31 100644 --- a/introduction.md +++ b/introduction.md @@ -1,8 +1,8 @@ # Introduction Writing Guidelines -v1.1 +v1.11 -The Introduction is the most important chapter in your report. +The Introduction is perhaps the most important chapter in your report. Typically, the structure is: commit 1b6f237249e0a07951642a50d0bb522a10207528 Author: Mark Claypool <claypool@cs.wpi.edu> Date: Tue Jan 28 17:14:59 2020 -0500 Updates diff --git a/introduction.md b/introduction.md index daef28b..a40e8ef 100644 --- a/introduction.md +++ b/introduction.md @@ -1,12 +1,12 @@ # Introduction Writing Guidelines -v1.0 +v1.1 The Introduction is the most important chapter in your report. Typically, the structure is: -+ Start broad, introducing the domain ++ Start broad, introducing the domain and why it is important + Narrow to the specific technology within the domain @@ -26,10 +26,10 @@ Typically, the structure is: the report. e.g., "Chapter 2 provides background and related technologies on ..." -*Important*: All of the above needs to be readable, have flow, -taking the reader from the broad to the narrow, providing an understanding -of why the domain and problem are important and giving a good -idea of what you did about the problem. +*Important*: All of the above needs to be readable, have flow, taking +the reader from the broad to the narrow, providing an understanding of +why the domain and problem are important and giving a good idea of +what you did about the problem. -It is best to outline the introduction before writing it. Do this at +It is best to outline the introduction before writing it. Do this at the paragraph level - think of topic sentences and supporting details. commit 982fdb3a1c891ab2da498a60842d3decd9616926 Author: Mark Claypool <claypool@cs.wpi.edu> Date: Sat Feb 16 08:24:31 2019 -0500 Updates diff --git a/introduction.md b/introduction.md new file mode 100644 index 0000000..daef28b --- /dev/null +++ b/introduction.md @@ -0,0 +1,35 @@ +# Introduction Writing Guidelines + +v1.0 + +The Introduction is the most important chapter in your report. + +Typically, the structure is: + ++ Start broad, introducing the domain + ++ Narrow to the specific technology within the domain + ++ Describe challenges + ++ Briefly mention solutions that attempt to meet those challenges + ++ Carefully say why those solutions are not sufficient + ++ The previous paragraph sets up your *problem statement* + ++ Describe the methods used to address the problem (think *verbs*) + ++ Provide the results - what you ended up with (think *nouns*) + ++ Last, give a "roadmap" (1 paragraph) on the layout for the rest of +the report. e.g., "Chapter 2 provides background and related +technologies on ..." + +*Important*: All of the above needs to be readable, have flow, +taking the reader from the broad to the narrow, providing an understanding +of why the domain and problem are important and giving a good +idea of what you did about the problem. + +It is best to outline the introduction before writing it. Do this at +the paragraph level - think of topic sentences and supporting details.