I recently had a project with a small group of users, maybe 35. I joined the project about a month before the scheduled release. I wasn't sure what kind of help the app needed, or what format. A wiki? Screencasts? Online help? A short PDF?
I talked with the lead customer, and he hadn't given much thought about help. I talked with the project manager, a quality assurance engineer, and a developer. The PM didn't know what kind of help the app needed either. The QA engineer thought it needed a few pages of help; a developer said it needed maybe 150 pages. After floundering around for about a week, I realized I was shooting in the dark.
I asked the interaction designer for some names of users I could contact, and he supplied me a name. After talking on the phone with the user for 5 minutes, I knew that my entire previous direction was wrong. They didn't need a robust wiki. "If you created a help system," the user said, "I'm really not sure anyone would use it. We all know the process so well here. The only thing we may need help with is to find where something is in the interface."
This lightened my load incredibly. The way our department often works, we create applications so customized to a specific business process that only users within that business department understand how the application will actually be used. Trying to penetrate this business process requires learning an entirely new culture and knowledge base. But often it isn't necessary to document this business knowledge -- it all depends.
When I started the project, I was fixed on creating documentation that explained not only the how, but the why and who and where and other context. Now I'm basically creating a slideshow of screenshots with some callouts indicating where things are in the interface. I figure it will save me about 2 months of work and will actually be looked at by the users -- all because of a brief phone call with users. I realized that I can learn more from talking with users for 5 minutes than I can from 2 weeks of project meetings. Why is it that I don't talk to users more frequently?
photo from Flickr
Get new posts delivered straight to your inbox.
I'm a technical writer based in the California San Francisco Bay area. Topics I write about on this blog include the following technical communication topics: Swagger, agile, trends, learning, plain language, quick reference guides, tech comm careers, and certificate programs. I'm interested in information design, API documentation, visual communication, information architecture and findability, and more. If you're a professional or aspiring technical writer, be sure to subscribe to email updates using the form above. You can learn more about me here. You can also contact me with questions.