commit 168e2c1a27b3c551152a80af7d381533d16475d1 Author: Mark Claypool <claypool@cs.wpi.edu> Date: Wed Aug 23 09:19:47 2023 -0400 Updates diff --git a/outline.md b/outline.md index 849e8e6..419fec0 100644 --- a/outline.md +++ b/outline.md @@ -1,6 +1,6 @@ --- pagetitle: Outlining -version: v1.0 +version: 1.0 --- # Outlining commit 19b0e3beb78e17cc3b58695be99da1d23e2400c2 Author: Mark Claypool <claypool@cs.wpi.edu> Date: Wed Dec 14 10:56:30 2022 -0500 Updates diff --git a/outline.md b/outline.md index f2509a3..849e8e6 100644 --- a/outline.md +++ b/outline.md @@ -32,13 +32,13 @@ first draft of a section, they will have the same material at the same level of detail. Writing style/form could differ, but content would be consistent across first authors. -*Note*: Often, the penultimate chapter (e.g., "Evaluation" or +**Note**: Often, the penultimate chapter (e.g., "Evaluation" or "Results") cannot be completely outlined when a full report outline is created (e.g., about 2/3 of the way through a project) since the exact form of the final results may not be known. But placeholders can be put in for the likely sub-sections. -*Tip*: Think of pictures/diagrams that will help explain your work, +**Tip**: Think of pictures/diagrams that will help explain your work, such as system architectures, process flow, major components. Use a note, such as "Include methodology diagram here" in the outline. commit 42a627e18ae5fee0b5f00fda8b16084d4760b09a Author: Mark Claypool <claypool@cs.wpi.edu> Date: Wed Dec 14 08:36:06 2022 -0500 Updates diff --git a/outline.md b/outline.md index 0d25e1f..f2509a3 100644 --- a/outline.md +++ b/outline.md @@ -1,6 +1,6 @@ --- pagetitle: Outlining -version: v0.7 +version: v1.0 --- # Outlining @@ -16,9 +16,9 @@ The idea is to create the outline first, before writing, and add/subtract/arrange/re-arrange until the flow is right and the content is complete. And only *then* starting to write. -The outline should not have paragraphs and probably not even -sentences, but bulleted lists (numbered as appropriate). This makes -it easier to scan for content and flow and re-arrange. +The outline should not have paragraphs and not even full sentences, +but bulleted lists (numbered as appropriate). This makes it easier to +scan for content and flow and re-arrange. Also include notes, where appropriate, indicating what is in a section. e.g., "Include tutorial code here" or "Graph of performance commit 0a3a035cc794a63af63c86c0c68decfdb2d808f2 Author: Mark Claypool <claypool@cs.wpi.edu> Date: Mon Aug 8 13:58:58 2022 -0400 Updates diff --git a/outline.md b/outline.md index 2b2fce3..0d25e1f 100644 --- a/outline.md +++ b/outline.md @@ -1,6 +1,9 @@ -# Outline Writing Guidelines +--- +pagetitle: Outlining +version: v0.7 +--- -v1.6 +# Outlining The outline provides the skeleton for an individual chapter or the whole report, sort of like a table of contents but with some @@ -39,4 +42,4 @@ put in for the likely sub-sections. such as system architectures, process flow, major components. Use a note, such as "Include methodology diagram here" in the outline. -**See also**: [writing-full](writing-full.html) one pager +**See also**: the [General Writing](writing-full.html) one pager commit dc120c6fe8b1a52f801b8b486cb86661fab977ba Author: Mark Claypool <claypool@cs.wpi.edu> Date: Fri May 20 11:48:50 2022 -0400 Updates diff --git a/outline.md b/outline.md index 6c5860e..2b2fce3 100644 --- a/outline.md +++ b/outline.md @@ -19,7 +19,7 @@ it easier to scan for content and flow and re-arrange. Also include notes, where appropriate, indicating what is in a section. e.g., "Include tutorial code here" or "Graph of performance -versus time" here. +versus time" here for any figures. For level of detail, the outline should include major sections, sub-sections, and sub-sub sections. It can even include paragraph commit 27469b4b69803e1877ac1585bb185b85a38d8135 Author: Mark Claypool <claypool@cs.wpi.edu> Date: Wed Jan 26 08:08:45 2022 -0500 Updates diff --git a/outline.md b/outline.md index 1ee0895..6c5860e 100644 --- a/outline.md +++ b/outline.md @@ -1,6 +1,6 @@ -# Outlining +# Outline Writing Guidelines -v1.5 +v1.6 The outline provides the skeleton for an individual chapter or the whole report, sort of like a table of contents but with some @@ -39,4 +39,4 @@ put in for the likely sub-sections. such as system architectures, process flow, major components. Use a note, such as "Include methodology diagram here" in the outline. -**See also**: writing-full one pager +**See also**: [writing-full](writing-full.html) one pager commit f502db686b62f8a70f73d56036f1e609139e00d5 Author: Mark Claypool <claypool@cs.wpi.edu> Date: Wed Dec 29 13:12:30 2021 -0500 Updates diff --git a/outline.md b/outline.md index 39d83ca..1ee0895 100644 --- a/outline.md +++ b/outline.md @@ -1,6 +1,6 @@ # Outlining -v1.4 +v1.5 The outline provides the skeleton for an individual chapter or the whole report, sort of like a table of contents but with some @@ -26,7 +26,8 @@ sub-sections, and sub-sub sections. It can even include paragraph topics (e.g., for the Introduction). The idea is to have enough details on the *content* so that no matter which teammate does the first draft of a section, they will have the same material at the same -level of detail. +level of detail. Writing style/form could differ, but content would +be consistent across first authors. *Note*: Often, the penultimate chapter (e.g., "Evaluation" or "Results") cannot be completely outlined when a full report outline is @@ -39,4 +40,3 @@ such as system architectures, process flow, major components. Use a note, such as "Include methodology diagram here" in the outline. **See also**: writing-full one pager - commit f0e297917cdb8ce64cf688c4ade5035455676b31 Author: Mark Claypool <claypool@cs.wpi.edu> Date: Tue Dec 7 11:51:26 2021 -0500 Updates diff --git a/outline.md b/outline.md index e0608d2..39d83ca 100644 --- a/outline.md +++ b/outline.md @@ -23,7 +23,7 @@ versus time" here. For level of detail, the outline should include major sections, sub-sections, and sub-sub sections. It can even include paragraph -topics (e.g., for the Introduction). The idea is to have enough +topics (e.g., for the Introduction). The idea is to have enough details on the *content* so that no matter which teammate does the first draft of a section, they will have the same material at the same level of detail. commit 164c4cc96eaa436e9a260f9ad7419022333b2929 Author: Mark Claypool <claypool@cs.wpi.edu> Date: Sun Nov 21 07:04:23 2021 -0500 Updates diff --git a/outline.md b/outline.md index 3b7cc89..e0608d2 100644 --- a/outline.md +++ b/outline.md @@ -1,23 +1,18 @@ -# OUTLINE +# Outlining -v1.3 +v1.4 The outline provides the skeleton for an individual chapter or the whole report, sort of like a table of contents but with some additional notes/details. The outline shows: + The *content* that is needed for the report. - + The *order* that the content is in. The idea is to create the outline first, before writing, and add/subtract/arrange/re-arrange until the flow is right and the content is complete. And only *then* starting to write. -For level of detail, the outline should include major sections, -sub-sections, and sub-sub sections. It can even include paragraph -topics (e.g., for the Introduction). - The outline should not have paragraphs and probably not even sentences, but bulleted lists (numbered as appropriate). This makes it easier to scan for content and flow and re-arrange. @@ -26,10 +21,18 @@ Also include notes, where appropriate, indicating what is in a section. e.g., "Include tutorial code here" or "Graph of performance versus time" here. +For level of detail, the outline should include major sections, +sub-sections, and sub-sub sections. It can even include paragraph +topics (e.g., for the Introduction). The idea is to have enough +details on the *content* so that no matter which teammate does the +first draft of a section, they will have the same material at the same +level of detail. + *Note*: Often, the penultimate chapter (e.g., "Evaluation" or -"Results") cannot be complete outlined since the exact form of the -final results may not be known. But placeholders can be put in for the -likely sub-sections. +"Results") cannot be completely outlined when a full report outline is +created (e.g., about 2/3 of the way through a project) since the exact +form of the final results may not be known. But placeholders can be +put in for the likely sub-sections. *Tip*: Think of pictures/diagrams that will help explain your work, such as system architectures, process flow, major components. Use a commit 1b6f237249e0a07951642a50d0bb522a10207528 Author: Mark Claypool <claypool@cs.wpi.edu> Date: Tue Jan 28 17:14:59 2020 -0500 Updates diff --git a/outline.md b/outline.md index 06bfb3e..3b7cc89 100644 --- a/outline.md +++ b/outline.md @@ -1,6 +1,6 @@ # OUTLINE -v1.2 +v1.3 The outline provides the skeleton for an individual chapter or the whole report, sort of like a table of contents but with some @@ -11,8 +11,8 @@ additional notes/details. The outline shows: + The *order* that the content is in. The idea is to create the outline first, before writing, and -add/arrange/re-arrange until the flow is right and the content is -complete. And only *then* starting to write. +add/subtract/arrange/re-arrange until the flow is right and the +content is complete. And only *then* starting to write. For level of detail, the outline should include major sections, sub-sections, and sub-sub sections. It can even include paragraph commit 385f82b8934327afa719a97fb9e7900893906afc Author: Mark Claypool <claypool@cs.wpi.edu> Date: Wed Sep 25 14:28:05 2019 -0400 Updates diff --git a/outline.md b/outline.md index c9fb38a..06bfb3e 100644 --- a/outline.md +++ b/outline.md @@ -1,10 +1,10 @@ # OUTLINE -v1.1 +v1.2 -The outline provides the skeleton for the report, sort of like a table -of contents but with some additional notes/details. The outline -shows: +The outline provides the skeleton for an individual chapter or the +whole report, sort of like a table of contents but with some +additional notes/details. The outline shows: + The *content* that is needed for the report. commit c5850b62b1f29e6f4a0d1405bf38d77edc4ed15d Author: Mark Claypool <claypool@cs.wpi.edu> Date: Wed May 1 06:40:12 2019 -0400 Updates diff --git a/outline.md b/outline.md index ef892ec..c9fb38a 100644 --- a/outline.md +++ b/outline.md @@ -35,3 +35,5 @@ likely sub-sections. such as system architectures, process flow, major components. Use a note, such as "Include methodology diagram here" in the outline. +**See also**: writing-full one pager + commit a7f8202c3b85d9cb988067b774f736150d5023b2 Author: Mark Claypool <claypool@cs.wpi.edu> Date: Sat Feb 16 07:33:19 2019 -0500 Updates diff --git a/outline.md b/outline.md index e5bf787..ef892ec 100644 --- a/outline.md +++ b/outline.md @@ -1,8 +1,10 @@ # OUTLINE -v1.0 + +v1.1 The outline provides the skeleton for the report, sort of like a table -of contents but with some additional notes/details. The outline shows: +of contents but with some additional notes/details. The outline +shows: + The *content* that is needed for the report. @@ -16,6 +18,10 @@ For level of detail, the outline should include major sections, sub-sections, and sub-sub sections. It can even include paragraph topics (e.g., for the Introduction). +The outline should not have paragraphs and probably not even +sentences, but bulleted lists (numbered as appropriate). This makes +it easier to scan for content and flow and re-arrange. + Also include notes, where appropriate, indicating what is in a section. e.g., "Include tutorial code here" or "Graph of performance versus time" here. commit c97ff59acd7ebe95708b2c988909b289356b55b3 Author: Mark Claypool <claypool@cs.wpi.edu> Date: Sat Feb 3 07:29:31 2018 -0500 Updates diff --git a/outline.md b/outline.md new file mode 100644 index 0000000..e5bf787 --- /dev/null +++ b/outline.md @@ -0,0 +1,31 @@ +# OUTLINE +v1.0 + +The outline provides the skeleton for the report, sort of like a table +of contents but with some additional notes/details. The outline shows: + ++ The *content* that is needed for the report. + ++ The *order* that the content is in. + +The idea is to create the outline first, before writing, and +add/arrange/re-arrange until the flow is right and the content is +complete. And only *then* starting to write. + +For level of detail, the outline should include major sections, +sub-sections, and sub-sub sections. It can even include paragraph +topics (e.g., for the Introduction). + +Also include notes, where appropriate, indicating what is in a +section. e.g., "Include tutorial code here" or "Graph of performance +versus time" here. + +*Note*: Often, the penultimate chapter (e.g., "Evaluation" or +"Results") cannot be complete outlined since the exact form of the +final results may not be known. But placeholders can be put in for the +likely sub-sections. + +*Tip*: Think of pictures/diagrams that will help explain your work, +such as system architectures, process flow, major components. Use a +note, such as "Include methodology diagram here" in the outline. +