| 1 |
Thomas Sachau posted on Sat, 16 Jun 2012 12:31:40 +0200 as excerpted: |
| 2 |
|
| 3 |
> Since i am not that sure about my ability to write formal specs, i am |
| 4 |
> presenting my first draft for further review and suggestions for |
| 5 |
> improvement. |
| 6 |
|
| 7 |
Just a format suggestion. Call it nitpicky if you want, and yes, my |
| 8 |
client isn't perfect, but I'm sure people with a bit of experience |
| 9 |
writing such specs will tell you I'm not alone... |
| 10 |
|
| 11 |
Several of your points ended up as very long single lines. My client can |
| 12 |
wrap, but that wraps the points as well (so for example 2.1 starts in the |
| 13 |
middle of a line). So I was left with the choice to either massively |
| 14 |
horizontally scroll, or of trying to figure out where one point ended and |
| 15 |
another began, since wrapping it... /wrapped/ it, so points appeared in |
| 16 |
the middle of a line. |
| 17 |
|
| 18 |
Please: |
| 19 |
|
| 20 |
* If you use long lines, leave a vertical space (blank line) between |
| 21 |
points so when a client wraps them, they wrap as individual paragraphs. |
| 22 |
|
| 23 |
* Alternatively, wrap at something sensible. (The traditional wrap for |
| 24 |
posting is 72 chars or so, 80 minus a few to allow a few levels of |
| 25 |
quoting without rewrap. I wouldn't complain at 90, but if you're going |
| 26 |
to bother, you might as well go the standard route and avoid further |
| 27 |
issues.) |
| 28 |
|
| 29 |
Long lines as paragraphs would probably be easier especially early in the |
| 30 |
process when you're modifying a lot, but you still risk (even more) |
| 31 |
limited clients having issues with it. YMMV. |
| 32 |
|
| 33 |
-- |
| 34 |
Duncan - List replies preferred. No HTML msgs. |
| 35 |
"Every nonfree program has a lord, a master -- |
| 36 |
and if you use the program, he is your master." Richard Stallman |
Archives