Many times during my work week, I am asked if there is documentation to do what I do. I sometimes say yes and sometimes say no. In either case, I am left wondering what documentation is adequate and what is not.
Let's suppose that you are trying to show or teach someone how to create a web page. Do you have to explain to them the http protocol and why it was instituted as a way of sharing files from continent to continent? Or how the computer works as you type on the keyboard? In any document, there is an assumption to the knowledge of the reader. Is this any more true in technical documents as opposed to news articles? What do I have to know about the failed coup attempt broadcast on NPR this morning to have a cognitive understanding of the situation?
Anyway, I feel like documentation is like talking to a wall. You never know if someone else will understand it until the time that they need it.
Let's suppose that you are trying to show or teach someone how to create a web page. Do you have to explain to them the http protocol and why it was instituted as a way of sharing files from continent to continent? Or how the computer works as you type on the keyboard? In any document, there is an assumption to the knowledge of the reader. Is this any more true in technical documents as opposed to news articles? What do I have to know about the failed coup attempt broadcast on NPR this morning to have a cognitive understanding of the situation?
Anyway, I feel like documentation is like talking to a wall. You never know if someone else will understand it until the time that they need it.
3 comments:
Could you upload some BIGGER pictures?
bman, I tried to upload the pictures in a smaller window, but it crapped out on me. so I am using the Medium size. I think I might go ahead and use the larger size just to appease you.
Okay, so you totally stole my bledsoesaidso! :^)
Post a Comment