Where’s the real value in documentation…
How much is too much?
when we’re not talking about what the client sees? I was talking with a developer friend at work today and learned that all the software changes and developments are meant to be for the use and benefit of the company. The software is for us – to make the business run better - and not on a track to be sold off to customers.
Then we started talking about documentation. If it was not needed for clients or customers, then why worry about it at all? Just as the software-in-development will be bringing us into a more efficient operation, proper documentation will be making clear to each other the change, news, and updates of which various levels of the company need to be aware.
The more accurate my communication via documentation or verbal understanding: the better I can facilitate a unified awareness of all the operations that I’m learning to any WWT employee, at any level.
The developers were required to do some of their own documentation, but it was mostly an obligatory procedure thing. He described the internal documentation as “poorly done.” I’m more than happy to meld together my inclination to organize and my pleasure at understanding how a new process works. When conveying these things together, I think that I can continue to develop an essential part of technical communication.
However, my manager brought up a good point the other day when he mentioned that people just don’t want text anymore. They want visuals. Text and visuals. Tom Johnson, in his blog, continually comes back to the idea that technical communicators need to move forward into a world of blogging, podcasts, videocasts, and social networking applications.
Perhaps, as I learn more about the company, I can find ways to come to a medium that utilizes the two in tandem.
RSS 
Email 
Thanks for the mention. I do argue that we need to move toward some of those things, but I must admit, I’m in an environment that restricts use of PHP/MySQL, which makes it difficult (except through SharePoint 2007). Video tutorials are huge, though. And with a tool like Camtasia Studio, they’re fairly easy to do. Quick reference guides also have a high value to customers.
You know, I had an opportunity to make a few video tutorials with Camtasia for my sister. She just bought a new laptop with Vista for college, and she has little-to-no idea how to take care of it. A couple tutorials later, she knows how to use the task manager to shut down programs, install and uninstall software, and manage torrent downloads.
I’d been wondering if there was a good way to fit Camtasia tutorials into Powerpoint presentations. I may try this for my sister. That way I can include documented steps and visual walkthroughs.
Everyone has different learning styles for sure. If you want to get across to a large group of people you need to using many different styles of communication. Im glad the world at large is coming on to this concept. Its something I learned a lot about in my first years of nursing.