Question
March 13, 2008 at 01:47 PM
double click

Technical documentation

by double click . Updated 18 years, 4 months ago

Not very proud to admit this, after several years of IT I can get to finally prepare documentation on ?projects? BEFORE they happen. The deal is I am in an environment were there is neither project scoping guidelines nor documentation guideline. I started with several documents but they all seem like they were written by a 16 year old and not a technical engineer. I usually find myself going too much into the details of the actual site setup or solution then rather outline what it all means. Also found huge difficulties structuring the document in a professional looking manner.

Instead of me going and blindly copying the dozen of documents one can find on the internet I would like to know how some of these technical writers/consultants actually come to where they are. I know there is also a great deal of experience required for writing up project documents, site documentation and technical focused motivational papers. Unfortuanly experience is something which comes past slow and difficult around here and on top of that I have to deal with management that require things to be in place by yesterday with the least amount of manpower and assessment time.

Would love to hear some comments or suggestions from the members.

This discussion is locked

All Comments