User Tools
appendix:guidebook_authoring
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
appendix:guidebook_authoring [2018/08/15 16:12] jguerin Started conventions section at the end. |
appendix:guidebook_authoring [2018/08/15 16:22] (current) kericson [Terse is Almost Always Better] - better? |
||
|---|---|---|---|
| Line 12: | Line 12: | ||
| * consistency in terms of structure (both overall organization and of page contents), | * consistency in terms of structure (both overall organization and of page contents), | ||
| * 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 locte information, | + | * easy to locate |
| - | * coverage of the broadest possible set of topics | + | * coverage of the broadest possible set of topics |
| While the guidebook is most likely going to originate out of the efforts of UT Martin professors/ | While the guidebook is most likely going to originate out of the efforts of UT Martin professors/ | ||
| 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 | + | * Terseness |
| * 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.1534367570.txt.gz · Last modified: 2018/08/15 16:12 by jguerin
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International
