Tips on Writing for the Web Environment
Writing for the web demands pithy sentences, skillful hyperlinks, point-first writing, clear division into sections, use of headings, lists and tables, images, and awareness of how punctuation looks on a screen.
Keep your writing taut and to the point. Some variation in syntax keeps your prose lively, but subject-verb-object syntax should predominate. Avoid baroque sentences with inverted syntax and subordinate clauses.
Point-first writing is particularly important in the web environment. Make sure each paragraph begins with a point sentence (sometimes called a topic sentence or mini-claim). Readers often skim in the web environment. Make sure the first sentence in each paragraph summarizes the contents of the paragraph.
Section Divisions and Headings
Web readers are accustomed to viewing shorter sections of text than are typically found in printed texts. Such an arrangement makes it easier for readers to scan the page quickly for the information that is of interest to them.
Divide your article into a number of discrete sections and use a short, descriptive heading for each section. Note that MoEML recommends particular headings for Encyclopedia pages. These headings will generate the Contents List that appears on the left-hand side of a MoEML page. We can encode up to five levels of sub-headings.
Paragraph lengths are typically shorter in the web environment than in print.
Lists and Tables
Bulleted or numbered lists work well in the web environment. We can encode either type of list very easily, as well as lists within lists.
Tables with 3-4 columns also work well in the MoEML environment. If you want your table to have sortable columns, tell us how you want them to sort (alphabetically or numerically).
We highly recommend the use of images in your contribution. Images illustrate your point(s) and also break up long blocks of text. See our Contributor Guidelines on the use of images.
Avoid using semi-colons (unless they appear in a quotation), because they look like commas on many screens.
Last modification: 2016-05-27 14:37:29 -0700 (Fri, 27 May 2016) (tlandels)