Wednesday, April 01, 2009

Assuming the Unassumable

Sa maka-relate lng... for all the tech writers out there...

from the wires...

By mapids

Created 2009-03-09 22:02

What exactly is the level of assumptions a technical technical writer can make? Firstly, the technical writer assumes his documentation helps the user to perform the tasks with ease. The technical writer also assumes that he has covered the software from all aspects.

For this, the technical writer assumes that he has the mastered the craft of writing. He has explained complex technical concepts in a language he thinks simple. He has designed the document in such a way that the user locates the information with ease. He has organised the topics to lead the user from one subsequent step to the other. He has even assumed responsibility of the correctness of the UI text and messages. (Testers do not care about the UI, right?). He has also assumed that he has done a usability test, while he does not clearly know what exactly usability is.

He assumes that the SMEs, project managers, and other stakeholders do an honest review of the document. He also assumes that they spend hours going through the documents, and are committed to helping him plug the gaps in the document. He knows that this is not the case, but assumes that whatever inputs he gets is fine.

Before every release, he also assumes that the peer reviewers have done their job and they do not do anything to harm him. He assumes that there are no secret parleys between his ambitious seniors and the manager. He also assumes that he will get bouquets and his opponents brickbats. He also assumes that the seniors will tell good things about him and hide his weakness from the manager. He also assumes that the client is not throwing up his arms in despair, but nodding his head in agreement. He also assumes that an appreciation mail is in the offing, and his image and standing in the office is all set to go up.

But can a technical writer, by himself, assume that his documentation is incomplete? Can a technical writer assume that his documentation is bad? Can a technical writer nod in agreement if told in a vague manner that his document is incomplete, but nobody is telling him why it is incomplete? Can a writer assume that his documentation is never complete release after release?

Is it wrong if a hapless technical writer assumes that a proper review mechanism could have made things more easier?