The miracle of technical documentation

I find this hilarious description of the technical documentation process in coding horror, along with labnotes, my favorite blog about programming.
The situation you are in is no different from any other tech writer. The technical writing process:
- Ask engineer how the damn thing works.
- Deafing silence.
- Crickets.
- Tumbleweed.
- Just start writing something. Anything.
- Give this something to the engineer.
- Watch engineer become quite upset at how badly you’ve missed the point of everything.
- As the engineer berates you, in between insults he will also throw off nuggets of technical information.
- Collect these nuggets, as they are the only reliable technical information you will receive.
- Try like hell to weave together this information into something enlightening and technically accurate.
- Go to step 6.
Warning: strtotime() [function.strtotime]: Called with an empty time parameter. in /var/www/vhosts/rogelsview.com/httpdocs/wp-content/plugins/disqus/disqus.php on line 130
blog comments powered by Disqus
Add New Comment
Thanks. Your comment is awaiting approval by a moderator.
Do you already have an account? Log in and claim this comment.
Add New Comment
Trackbacks