Difference between revisions of "Specs/style"
(Start style guide.)
Revision as of 15:01, 6 November 2013
When writing a spec, it is suggested that you adhere to the following guidelines.
Bags of bits
- Be careful of your use of the terms "file" and "resource".
- Make sure your definitions refer only to bags of bits, and not also stuff in the Real World™ (like apple baskets).
Willful violations of other specs
- When willfully and deliberately violating standards set out in other documents, use the term "willful violation" instead of simply "violation".
- "Violation" makes you sound naughty; "willful violation" makes you sound knowledgeable.