The Mystery of the Special Occasion
Feb. 3rd, 2010 05:01 pmSo I'm working on a document for a product that has an import and export feature. The feature is pretty straightforward, but being a conscientious technical writer, I want to include context is when and why a user would want to import or export the data in this application. Just so you know, the sections are called Importing Data and Exporting Data as an SQL File.
I write to the coders (who are in France) and ask them for examples on when and why a user would perform these tasks. Here's what I get:
And I'm thinking What part of the title doesn't tell you all that already?!?! This just reminds me of what coders really think of the technical writers: when we're too stupid to really understand the technology, so we just parrot the obvious so that the lawyers can say we covered our asses.
So I write back and ask what is this Special Occasion would be ("I can't just put "special occasion" as when to perform these tasks. I need a reason!"). He writes back:
After asking a few more probing questions, I finally came up with something to give the user some context for these features, but I got mostly blank stares from everybody. I think I'm going to suggest to the marketing team that include a complementary mirror and smoke machine to make those special occasions more dramatic.
I write to the coders (who are in France) and ask them for examples on when and why a user would perform these tasks. Here's what I get:
France coder: Write this for each section:
Importing Data: This process explains how to import data. You only do this for a special occasion.
Exporting Data as an SQL File: This section explains how to export the data as an SQL file. You only do this for a special occasion.
And I'm thinking What part of the title doesn't tell you all that already?!?! This just reminds me of what coders really think of the technical writers: when we're too stupid to really understand the technology, so we just parrot the obvious so that the lawyers can say we covered our asses.
So I write back and ask what is this Special Occasion would be ("I can't just put "special occasion" as when to perform these tasks. I need a reason!"). He writes back:
France coder (this is copy/pasted from his email): I have no idea. I personally have no example but from my experience in SW support I know it may be usefull one day.
After asking a few more probing questions, I finally came up with something to give the user some context for these features, but I got mostly blank stares from everybody. I think I'm going to suggest to the marketing team that include a complementary mirror and smoke machine to make those special occasions more dramatic.
Pay no attention to the man behind the curtain! He may be importing or exporting data, but no one know why!
WHIIIZZZZ BANG!