SDSC Writing Guide

Note

This is out of date. While the stylistic concerns are valid, pages on the Wiki are preferred to HTML.

Version 1.00

SDSC Writing Guidelines

It can be difficult to coordinate a team of multiple people working on a single project, especially when the team is geographically separated. To ease task management a few writing guidelines are provided below to ensure that the highest quality documents possible are created. Please try to keep these guidelines in mind as you write SDSC documents:

• Use the S8-Dev message board to announce which section(s) you will be working on, both to inform others of your work and avoid duplication of effort.
• Proofread your contributions for spelling and grammatical errors.
• For each new keyword or term you introduce, provide a link to a glossary entry. Also, provide a detailed glossary entry for the term.
• Provide reference information (bibliography entries) if applicable.
• Write in HTML.
• Limit line lengths (in the HTML source file) to 80 characters. (Most SDSC documents will have a ruler at the top of the page to indicate the 80 character width).
• Use of hyper-links is strongly encouraged, especially to glossary entries.
• Under NO circumstances should the phrase \"Click here\" be used as a hyper-link.
• Use the NAME directive to name each section based on the section number. This is essential for maintaining a Table of Contents. (Refer to the SDSC Document Template for examples.)
• Figures should be named as follows: take the section number and append a letter. Start with letter "a" and move through the alphabet (in order) as needed. For example the first figure in section 4.3.2 would be named Figure 4.3.2.a, the second figure would be Figure 4.3.2.b
• Dates should be of the form: Month Date, Full Year. Ex: May 2, 2001
• Use WLA-DX Z80 assembly language when giving code examples.
• Numbers should be represented using WLA-DX format:

Hexadecimal

$C2

Binary

%11000010

Decimal

194

• Use the SDSC Document Template as a starting point, and as an example of basic document design.

• Back to SDSC index

• Back to Development index