Documentation Quality Parameters

The quality parameters of documentation are often laid on the time taken to complete the documentation. I think this premise is false. In this post, I discuss about what a quality parameter should check. Read on.

Note: This stub contains links for the articles, which are placed under different tabs. Access the article either directly from the related tab or through the link in the stub. The stub is for only referential and record-keeping purposes.

For the restless. For those who rest less.

It is good to slow down once in a while.

Life is a race. We reach for whatever we wish We endure even our daily tasks. We make sure that we take the extra step, go the extra mile, to strive and achieve what we set out for. And we do get success. We do make our mark. But, in the process, we have lost (invested?) a lot of energy. Energy – which is precious, limited, and needs recharge – depletes with every step we take towards our goals.

We know we are restless. And we must rest less if we must pursue our goals. But, that does not mean we mustn’t take rest. That the pursuit shouldn’t let us suffer our journey towards our goals. The idea, therefore, is to slow down once in a while. Give ourselves the rest we deserve. To treat ourselves with the comfort of moving ahead of our tasks, schedule, and plans. The rest can not only provide us with the much-needed gap, it also supplies us with some extra time so that we can evaluate ourselves.

Restlessness is good. Restlessness is must. But, it must not pave the path for less rests. Take rest. Take pride, enjoy your journey towards your goal.

Suyogsutra

Wabi-Sabi and Technical Communication

Wabi-Sabi is the Japanese window of perspective of the acceptance of imperfection. It centres the thought that everything in this world is imperfect, incomplete, and impermanent. And, when everything is made that way, we must strive continuously for perfection, by making it a habit to improve ourselves and everything we do. This post is a call to realize the importance of imperfection in our lives. Imperfection, which I believe is quite perfectly placed as the first step towards perfection.

Note: This stub contains links for the articles, which are placed under different tabs. Access the article either directly from the related tab or through the link in the stub. The stub is for only referential and record-keeping purposes.

Who am I?

Technical communicators, as I have later concluded in the post, are a link that interconnects the inter-departmental communication. They provide words to the thoughts, meaning to the codes, and comprehension for the features of their company’s products. In this post, I talk about the different things that a tech communicator does. I hope you will like reading it.

Note: This stub contains links for the articles, which are placed under different tabs. Access the article either directly from the related tab or through the link in the stub. The stub is for only referential and record-keeping purposes.

Keep Work-Attit…

Keep Work-Attitude. Don’t Keep Working on Attitude.

For all of us, the easiest way to prove that we know a lot of things is to keep our mouth shut. The lesser we talk, the more others think we know. But the trick works only if we really “know”. Likewise, a hoarding attitude will only take other’s perception of us a step further, but only we can sustain that image, by contributing work of that (perceived) quality.

Attitude is good only if you are controlling it (and bad if it is controlling you).

Therefore, to control your attitude, you must know and understand the reason behind it. If you think you WANT it just because you can influence your perceived image, you should avoid projecting it. But, if you NEED it to enhance your own perception of issues, you should begin projecting it.

The following Shloka of the Bhagawat Gita, explains the same principle to us:

Karamanya Vadhikarasthe Maa Phaleshu Kadachana

Maa Karma Phala Hetur Bhurma Te Sanagostvakarmani

Chapter 2, Verse 47

Lord Krishna wants us to understand that only by creating the outer shell of results and perception, one cannot create a success story for himself. One must walk the talk, do what he is supposed to do, gain knowledge and wisdom, create positive, the affirmative energy around him, and continue to flow in that energy.

Success, which is the by-product of that positive energy, will come along, without your thinking about it. But, if you showcase attitude (ditch yourself), you will begin to think about the results, and therefore, will gradually stop working towards the objectives, and perish.

Therefore, stop talking about your work. Instead, let your work talk for you. Such an attitude, as I think, is Karma Yoga.

Collecting Key Information from SMEs.

I’ve observed that the subject matter experts (SMEs) are difficult to talk to. In most cases, it is difficult to bring out key information from them. But, when you know what makes them talk, your job becomes a bit easy. In this post, I talk about the techniques I use in order to collect key information and translate it into understandable chunks of information, later.

Note: This stub contains the link to the article, which is tucked within this site. The stub is for only referential and record-keeping purposes.

Rhetoric Series: Part 1

This is the first part of the series of posts. The second part is appropriately linked in the comments section of the post. Rhetoric, as a study, is increasingly becoming relevant in the technical communication industry. Writers, editors are now feeling the need to incorporate a rhetorical approach to improving the effectiveness of their work… and hope that it improves the readability (readership?).

Note: This stub contains the link to the article, which tucked within this site. The stub is for only referential and record-keeping purposes.

Standardize in order to Differentiate

It is good to be different. But, when everyone is trying to be different, nobody becomes different. In this post, I’ve tried to talk about why I feel standardization can be good for documentation, and how following standards can become the difference.

Note: This stub contains the link to the article, which tucked within the site. The stub is for only referential and record-keeping purposes.

The Absolute Knowledge of Self Discovery

The absolute knowledge of self-discovery.

Each one of us is born with a vision: To create a better vision for those who will follow us. The pursuit of this vision goes through many milestones. The milestones of righteousness, self-analysis, acceptance, corrections, invention, and acknowledgment.

The journey begins with righteousness. We must first learn to know the difference between the right and the wrong. No one is perfect. Not even god. But, there are ways we can judge what can make us perfect. To be able to judge the difference between the perfect and the imperfect, we must know what to do to steer more towards the perfect. The outcome of the self-assumed task is the right and the wrong. The two flip sides of any self-assumed task, they are mutually dependent. One cannot exist without other. Do more of one in comparison to the other to move more towards perfection. Wrong is not wrong unless we do what is right. Moreover, wrong is just a state. So, that doesn’t mean a person or thing is wrong because that is what it is. Hence, being wrong doesn’t make you wrong; Doing wrong does. Do right.

The next milestone is of self-analysis. More rights and less of wrong do not make one perfect; they just steer one towards perfection. One must assess the actions, constantly, to avoid the recurrence of wrong. That is self-analysis. A constant Chakra (or circle) of calculating behavior. Calculate the actions, depending on the degree of severity of issues to take steps, and move ahead.

The next step is of acceptance. Inside, we are all the same. No one is bad by birth. Remember, for those who behave badly, the bad is their definition of good. But, they still have a definition for good. Accept that. You may not change who they are, but you will certainly change the way you look at them. Perhaps, mere acceptance might bring them to the crossroads of self-analysis. But, it is easier said.

Correction is the next step. We are dependent. Correcting our wrong will bring the change into others behaviors. Their corrections will inspire you to do more right. Get inspired and inspire others; learn with examples and lead by examples.

Invent. Evaluate for yourself. Correct wherever required. Bring good to others; keep doing good. Invent newer ways to bring good. Evolve continually.

Acknowledge. A collective growth brings us to the state of a collective consciousness. The consciousness that the intention of bringing more of good to others isn’t really an invention, but a discovery. It is only then we will come to know that absolute knowledge is no different from the actual one. The absolute knowledge is nothing but the acknowledgment of ourselves. The acknowledgment that we are self-discoverers for all our lives. The discovers who are in the pursuit of the collective perfection.

– Suyogsutra

Weaknesses

Weaknesses are our greatest threats, but to have a threat is by itself the great weakness.

We, all of us, are held, tied-up in strings that we invented ourselves. The strings that aren’t really there. The beads that form the strings are made-up of our “assumed” weaknesses and threats. We assume that they exist just to hold us back from all the glory.

As humans, we must constantly strive towards breaking those beads. We must the acquire knowledge, to free ourselves of the strings that hold us back. An attempt by itself is strong enough break us free from the strings of weaknesses and threats.

Our weaknesses are our biggest enemies. They threaten us to not to perform – to not to attempt breaking free from the strings. The threat of losing; the threat of non-performing; or the threat to our lives – threats are what makes us weak. And as weak, individually or collectively, we cannot bring any change.

Only the knowledge of truth can free us from our threats. The knowledge that nothing is permanent. The threats that weaken us will not really be there tomorrow. The weaknesses, that yesterday held us from bringing the change, will disappear tomorrow. This simple fact that the threats are only temporary removes half of our weaknesses, and hence break us free of the strings.

And once we are free, we must choose a path for us, and reach to the absolute abode of strengths. The abode where we aren’t weak anymore. We aren’t frightened and scared anymore. We are liberated beings. Free.

– Suyogsutra