: Re: How much detail when writing technical documentation? As a software developer, I often find myself writing my own technical documentation and user guides. How much detail should be put into

It depends on who your target audience is and what the purpose is. If you are writing for uneducated users who just need to be able to use the product, keep details to the very minimum. Clear, logical steps that allow tasks to be completed is what's needed.

If, however, you want your user to understand how the product works so that they can use it more creatively, give more details.

Consider what some documentation does: What is needed for general consumption is the normal text, but there are specially labelled 'expert' sections -- read them if you need or want to. Alternatively, provide an introductory tutorial and then detailed technical information for people who want to do more.

Load Full (0)

: How do you find new venues to publish your work? With 5000+ markets what strategies and tactics have you found useful to pinpoint your submissions and find new markets to publish your work

@Bryan361

Load Full 2 Comments

: Transfer from first person to third person I'm in the process of editing my novel, and realized that it would be much better when narrated in third person. i was a much better person when

@Bryan361

Load Full 3 Comments

:

@Bryan361

Load Full 0 Comments

: Metaphors and other "tricks" in scientific papers In scientific papers (in my case it's usually in computer science) it seems to me that some techniques which help in explaining concepts and

: Re: How much detail when writing technical documentation? As a software developer, I often find myself writing my own technical documentation and user guides. How much detail should be put into

More posts by @Bryan361

: How do you find new venues to publish your work? With 5000+ markets what strategies and tactics have you found useful to pinpoint your submissions and find new markets to publish your work

: Transfer from first person to third person I'm in the process of editing my novel, and realized that it would be much better when narrated in third person. i was a much better person when

:

: Metaphors and other "tricks" in scientific papers In scientific papers (in my case it's usually in computer science) it seems to me that some techniques which help in explaining concepts and

Login to post a comment!

0 Comments

Back to top