Clear and understandable format spec writing
Posted: Wed Feb 08, 2012 7:24 pm
Graphics, audio, images, 3D, etc.
There doesn't seem to be a set standard for spec-writing.
Some of it can be very technical, or very verbose.
Some people are really comfortable with technical specs, while others probably not so much.
Any ideas on making easy-to-understand yet precise format specs?
There's only a finite set of types to work with. Signed values?
Structs would make sense. Defined in-line? Separately?
Array syntax? C-like syntax? Even with an array of structs?
What about strings? Null-terminated strings? Strings with specific encodings? I would like an easy way to say "this is a null-terminated string".
I've been used char_/0 lol
What are some good or bad specs you've seen?
There doesn't seem to be a set standard for spec-writing.
Some of it can be very technical, or very verbose.
Some people are really comfortable with technical specs, while others probably not so much.
Any ideas on making easy-to-understand yet precise format specs?
There's only a finite set of types to work with. Signed values?
Structs would make sense. Defined in-line? Separately?
Array syntax? C-like syntax? Even with an array of structs?
Code: Select all
uint16[10] some ints...
Vertex[20] vertices...
I've been used char_/0 lol
What are some good or bad specs you've seen?