3 ms·
* Start with a title. The title must state the purpose of the document in as few words as possible and that purpose must be narrow in scope as there can be othe
by throwaway0asd 4y ago
* Start with a title. The title must state the purpose of the document in as few words as possible and that purpose must be narrow in scope as there can be other documents for things out of scope.
* Provide a version and/or date.
* If the title insufficiently describes purpose in five words or less then provide an abstract.
* Describe your terms. This is your primary opportunity to achieve precision, don’t waste it.
* The body of the spec should flow in a linear progression and read like an instruction manual. The goal is not entertainment but rather reference first with examples and proofs. Remember that writing instructions is not scholarly yet simultaneously most people cannot follow a series of simple instructions, so ignore audience reading level and be true to the subject matter.
* At the end provide limits on the scope of criteria and any security concerns.