: Re: What is considered an acceptable length for a technical document? I have written dozens of technical and requirement specifications, and edited dozens more in 8+ years of engineering. The largest

I really don't think there is an answer. Working in a technical field myself, I have been frustrated by documentation that is too short, and doesn't provide answers to the questions I'm looking for but also seen documentation that is simply too long and makes it impossible to find the quick answers you usually need as a reference.

I'd expect the documentation for a lightswitch to be reasonably short. Whereas the documentation for a nuclear submarine should be considerable.

Documentation should simply be functional when used by someone with the appropriate skill level. After that the length is irrelevant.

Load Full (0)

: I need to smash a wrist in a grocery store One of my lead characters has to do community service at a grocery store. She has magical powers that will allow her to escape easily, but they

@Speyer920

Load Full 2 Comments

: Should I write "what do the data show" or "what does the data show"? I wonder what the proper way of writing this question is: What do the data show? What does the data show?

@Speyer920

Load Full 1 Comments

: How to find the balance between research and the obvious I'm embarking on writing my first popular science book on a controversial subject. For sure the writing must be rational, coherent with

@Speyer920

Load Full 3 Comments

: It depends, but probably you want the distributed approach where the chapter on X tells you everything you need to know about X, even if some of that is only relevant if you're using feature

: Re: What is considered an acceptable length for a technical document? I have written dozens of technical and requirement specifications, and edited dozens more in 8+ years of engineering. The largest

More posts by @Speyer920

: I need to smash a wrist in a grocery store One of my lead characters has to do community service at a grocery store. She has magical powers that will allow her to escape easily, but they

: Should I write "what do the data show" or "what does the data show"? I wonder what the proper way of writing this question is: What do the data show? What does the data show?

: How to find the balance between research and the obvious I'm embarking on writing my first popular science book on a controversial subject. For sure the writing must be rational, coherent with

: It depends, but probably you want the distributed approach where the chapter on X tells you everything you need to know about X, even if some of that is only relevant if you're using feature

Login to post a comment!

0 Comments

Back to top