Tek-Tips is the largest IT community on the Internet today!

Members share and learn making Tek-Tips Forums the best source of peer-reviewed technical information on the Internet!

  • Congratulations Mike Lewis on being selected by the Tek-Tips community for having the most helpful posts in the forums last week. Way to Go!

Help with technical document 1

Status
Not open for further replies.

nissan240zx

Programmer
Jun 26, 2005
280
US
Hello All,
Not sure if this is the right forum.
I am looking for some examples/templates for writing a technical implementation guide.

Please advice...

Nissan

A good programmer is someone who looks both ways before crossing a one-way street. - Doug Linder
 
Who is the audience?

Chip H.


____________________________________________________________________
If you want to get the best response to a question, please read FAQ222-2244 first
 
Audience is technical development team.

A good programmer is someone who looks both ways before crossing a one-way street. - Doug Linder
 
Just write it as if the person was sitting the cube with you. Then go back and refactor it so that related topics are put with each other.

For a technical audience, content is much more important than appearance.

Chip H.


____________________________________________________________________
If you want to get the best response to a question, please read FAQ222-2244 first
 
chiph

Sensible solution - avoids much of the boilerplate padding you see in most documentation. Have a star.

Steve

[small]"Every program can be reduced by one instruction, and every program has at least one bug. Therefore, any program can be reduced to one instruction which doesn't work." (Object::perlDesignPatterns)[/small]
 
Status
Not open for further replies.

Part and Inventory Search

Sponsor

Back
Top