User Tools

Site Tools


appendix:guidebook_authoring

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
appendix:guidebook_authoring [2018/08/15 16:19]
kericson [Overview] - fixed typo
appendix:guidebook_authoring [2018/08/15 16:22] (current)
kericson [Terse is Almost Always Better] - better?
Line 13: Line 13:
   * consistency in terms of tone (as though the entire endavor was written from the perspective of a single author),   * consistency in terms of tone (as though the entire endavor was written from the perspective of a single author),
   * easy to locate information, driven primarily by working examples,   * easy to locate information, driven primarily by working examples,
-  * coverage of the broadest possible set of topics reltaed to the general field of computer science.+  * coverage of the broadest possible set of topics related to the general field of computer science.
  
 While the guidebook is most likely going to originate out of the efforts of UT Martin professors/coaches and students, we hope to eventually have additional volunteers assisting with guidebook development. While the guidebook is most likely going to originate out of the efforts of UT Martin professors/coaches and students, we hope to eventually have additional volunteers assisting with guidebook development.
Line 48: Line 48:
 ==== Terse is Almost Always Better ==== ==== Terse is Almost Always Better ====
   * This page may be the worst example of this principle.   * This page may be the worst example of this principle.
-    * Verbosity in this page is sacrifice to produce consistency elsewhere.+    * Terseness in this page is sacrificed to produce consistency elsewhere.
   * Keep editing to say everything in a few short statements.   * Keep editing to say everything in a few short statements.
   * Pull content into auxiliary pages as necessary, make liberal use of links.   * Pull content into auxiliary pages as necessary, make liberal use of links.
appendix/guidebook_authoring.1534367941.txt.gz ยท Last modified: 2018/08/15 16:19 by kericson