(Technical Writing) How to start documenting a product?

0 ⤊

(Technical Writing) How to start documenting a product?

I want to know the standard steps to start documenting a product ( basically a software).

2006-09-06 17:41:20 · 2 answers · asked by amantalwar04 1 in Education & Reference ➔ Standards & Testing

2 answers

Write a plan for the library, including item, size, audience, medium.

For each item in the library, write a table of contents.

For each item in the table of contents, write a detailed outline.

2006-09-10 16:51:46 · answer #1 · answered by george_klima 3 · 0⤊ 0⤋

I am not a technical writer, but the basics apply:

What is it?
What is it supposed to do?
How do we make it do that? (In substantial detail)
What can go wrong?
What special tricks can it do?

2006-09-07 00:48:49 · answer #2 · answered by Computer Guy 7 · 0⤊ 0⤋