Tag Archives: Software engineer

Why hiring a Software Engineer as a Technical Writer is a good idea?

Before you jump the gun let me clarify, I am not talking about all Software Engineers. I am talking about those Software Engineers who have a flair for writing and who want to shift base to technical writing. I am neither in any way implying that Technical Writers from other fields are not competent enough to be recruited.

My case in point is: when a Software Engineer is rejected for a Technical Writer position for lack of experience. Now that I am done with the clarification part, let me get back to:
Why I think a Software engineer’s experience must not be discounted on grounds of it being irrelevant to Technical Writing field? And why recruiting Software Engineer as a Technical Writer is a win-win situation for both the company and the aspiring Technical Writer?
Let me answer that question by showing you a very simple analysis.

Divide the Technical Writers and Software Engineers into two groups based on the development life cycles they follow.

Note: This analysis is limited to Technical Writers in Software field because honestly I know nothing about the good Technical Writers in other fields. And yes, I know, it’s my loss.

Software Development Life Cycle (SDLC) is a structured way to develop a Software Product. Every Software Engineer takes part in the SDLC of the product he is working on. Similarly Document Development Life Cycle (DDLC) is a structured way to develop the Software Documentation and every Technical Writer typically participates in the process. Wikipedia has detailed articles on both types of methodology for the uninitiated.
I have a flowchart that depicts the different stages of both development life cycles (Stage names courtesy: Wikipedia).

Development Lifecycle

Development Lifecycle

Do you notice that some stages of the development life cycles intersect? It has to, why? Because both the parties are working on the same software product.

Typically the developers and writers will be involved in similar stages throughout the life cycle. Developers and Technical Writers need to do the Requirement analysis, they need to design their implementation/documentation, and they need to maintain the code/document that they have worked so hard to create. The other similar tasks are Testing/editing, the code needs to be tested and the documentation needs to be edited. The code has to be deployed and the documentation has to be published. The only difference lies in the implementation part where a developer works on coding the product and the writer works hard to create the document.

Do you still think that a Software Engineer doesn’t have enough relevant experience to be a Technical Writer?
I rest my case on why i think hiring a Software Engineer as a Technical Writer is a good idea by showing this Pie chart created based on statistics given by field experts.

What Technical Writers do?

What Technical Writers do?

According to field experts a Technical Writer spends almost 50% of his time gathering requirements, 10% in designing the document, 20% in actual writing and the rest of the 20% in reviewing and publishing the document.

Considering these factors:

  • Aren’t Software Engineers almost 70% job ready as Technical Writers?
  • Should their Software Engineering experience be completely discounted?
  • Shouldn’t their Requirement gathering skills, Reviewing skills be considered before rejecting them on the basis of lack of relevant experience?

What do you think? Should the skills of Software Engineers be completely discounted? Can their experience be counted as relevant experience?
Brickbats or bouquets,do send it with your feedback and opinion.

2 Workplace behavior tips I picked up from my maid

The other day my current maid who is a hard and efficient worker did a real great job of cleaning up my house. I was particularly impressed by the hassle free attitude she has towards her work. After cleaning up my house she came to me and politely asked for a raise. Being super impressed with her work I felt she deserved the raise and happily obliged her.

Now let me rewind to a similar incident that took place a few months earlier when my ex-maid was working. A major cribber, she found fault with everything in my house. “Your kids are too rowdy, they are always throwing away their toys”, “My earlier employer had a neat house, I hardly had to do anything” and so on. Not being used to being reprimanded by my maid, I was shocked by her attitude. It was her job, and I had clearly stated her job description before employing her, why then was she creating such a fuss over the work she willingly took up? Strangely enough she was not willing to quit the job either.  After few months of a very uncomfortable employer employee relationship, she suddenly demanded a salary hike hinting at the fact that her lack luster performance was due to her dis-satisfaction with the salary. I politely declined her offer and showed her the door. Asking for a salary hike is OK but there is a way to do that. You cannot justify your below average performance by accusing your employer of not paying you enough, especially when you have discussed and agreed upon the salary beforehand.

I believe that no work on earth is beneath us, we all do what we can do. Just because I aspired to be a CEO of a company, I cannot be disinterested in my humble work as a Software engineer or a Technical Writer. I need to give the respect due to my profession and I have to do that work with utmost dedication almost bordering on devotion.  Being a citizen of Gandhi’s nation I wholeheartedly believe in his opinion that “Nearly everything you do is of no importance, but it is important that you do it.”

That said, let’s compare the two scenarios:

  1. First one proves herself worthy of a raise. Asserts herself without fearing the consequences or doubting her employer. Asks for her rights, politely and respectfully.
  2. Second one neither shows interest in her work, nor proves her worth. Cribs and insults the employer. Demands a raise assuming that the employer has no other option but to give in to her demands.

What are your top take-away points from these two stories? I would like you to pitch in and state your take away. Meanwhile I’ll state mine: Continue reading →