what exactly is Technical Writer
-
this is bugging me for a while, What exactly a Tech. Writer DO.. My thinking.. just Doing a documentation in technical words ----------------------------------------------------------------- Its not the fall that kills you; it's the sudden stop at the end.
-
this is bugging me for a while, What exactly a Tech. Writer DO.. My thinking.. just Doing a documentation in technical words ----------------------------------------------------------------- Its not the fall that kills you; it's the sudden stop at the end.
As well as verifying the correctness of the specification. xacc.ide-0.1-rc4 released! Download and screenshots
-
this is bugging me for a while, What exactly a Tech. Writer DO.. My thinking.. just Doing a documentation in technical words ----------------------------------------------------------------- Its not the fall that kills you; it's the sudden stop at the end.
I had one write my program documentation once, once she finished her version made my documentation look like it was written by a 5 year old child. She used the spec, my user documentation and then sat down using the code to write the user guide, asking me any questions along the way.
"Normal is getting dressed in clothes that you buy for work and driving through traffic in a car that you are still paying for - in order to get to the job you need to pay for the clothes and the car, and the house you leave vacant all day so you can afford to live in it." - Ellen Goodman
-
this is bugging me for a while, What exactly a Tech. Writer DO.. My thinking.. just Doing a documentation in technical words ----------------------------------------------------------------- Its not the fall that kills you; it's the sudden stop at the end.
System.IO.TechWriter tw = new System.IO.TechWriter(stream);
tw.WriteDocumentation(myCode);
tw.WriteUserGuide(myProduct);
...
tw.Close();Sorry... very bad joke... :-> Basically, a technical writer communicates technical information via writing, in an accurate, usable, readable way. That includes writing documentation, user guides and how-tos, whitepapers, specifications, reports, structural plans, etc, for technologies or a technical field.
-
I had one write my program documentation once, once she finished her version made my documentation look like it was written by a 5 year old child. She used the spec, my user documentation and then sat down using the code to write the user guide, asking me any questions along the way.
"Normal is getting dressed in clothes that you buy for work and driving through traffic in a car that you are still paying for - in order to get to the job you need to pay for the clothes and the car, and the house you leave vacant all day so you can afford to live in it." - Ellen Goodman
Wish ours did that. She's more a of glorified librarian ensuring the documents are written and filed, but has not idea about the content. I've not even sure she knows what our products do!
-
System.IO.TechWriter tw = new System.IO.TechWriter(stream);
tw.WriteDocumentation(myCode);
tw.WriteUserGuide(myProduct);
...
tw.Close();Sorry... very bad joke... :-> Basically, a technical writer communicates technical information via writing, in an accurate, usable, readable way. That includes writing documentation, user guides and how-tos, whitepapers, specifications, reports, structural plans, etc, for technologies or a technical field.
Neat simple "managed" Technical Writer ... ;P
-
Wish ours did that. She's more a of glorified librarian ensuring the documents are written and filed, but has not idea about the content. I've not even sure she knows what our products do!
Ours was brilliant, I learn't loads from her. She would spend hours trying to decide if she should use the word 'must' or 'should' in a sentance, she even had loads of books on the subject! She would have made an excellent computer nerd, like us :-O
"Normal is getting dressed in clothes that you buy for work and driving through traffic in a car that you are still paying for - in order to get to the job you need to pay for the clothes and the car, and the house you leave vacant all day so you can afford to live in it." - Ellen Goodman
-
System.IO.TechWriter tw = new System.IO.TechWriter(stream);
tw.WriteDocumentation(myCode);
tw.WriteUserGuide(myProduct);
...
tw.Close();Sorry... very bad joke... :-> Basically, a technical writer communicates technical information via writing, in an accurate, usable, readable way. That includes writing documentation, user guides and how-tos, whitepapers, specifications, reports, structural plans, etc, for technologies or a technical field.
-
this is bugging me for a while, What exactly a Tech. Writer DO.. My thinking.. just Doing a documentation in technical words ----------------------------------------------------------------- Its not the fall that kills you; it's the sudden stop at the end.
The kind of guys who write stuff like MSDN :-D
-
this is bugging me for a while, What exactly a Tech. Writer DO.. My thinking.. just Doing a documentation in technical words ----------------------------------------------------------------- Its not the fall that kills you; it's the sudden stop at the end.
The main thing a technical writer does is translate a technical topic into terms a given audience can understand. This can mean writing manuals, help text, brochures, or any other type of documentation. The best ones have the ability to bridge the gap between the engineer or developer and the user. They do this by being sufficiently proficient technically that they can acquire an understanding of the subject matter, but they can also view it from a user's perspective. Like engineers, there are good ones, bad ones, and an awful lot of mediocre ones.
Software Zen:
delete this;