Feeds:
Posts
Comments

I am a technical writer

There is a huge misconception that people in IT do not lead happening-intersting lives, particularly technical writers. In fact a friend of mine, who is a happening insurance agent wondered if I was checking the alignment of sub-titles while we were watching a movie together :( .

This is grossly unfair. Cherryleaf came out strongly to counter this bullish, boring unfair, one-dimensional, untrue, unfair …. and blah blah opinion and invited technical writers to show the real, true, fair, happening and interesting face to the world.

You can check it at: http://www.cherryleaf.com/imatechwriter9.htm.

Any questions or myths?

Hi All

I recently started using Arbortext Editor (5.2) and I am terribly stuck.

I am working on a root document (combination of Ref Guide, Quick Guide and Online Help). Take an example where I have a task with a title as ‘Sending Invoice to Archives’. It has its corresponding xref as ‘AF.Admin.Sending.invoice.to.archives’, and I see a corresponding file entity (XML) with name AF.Admin.Sending.invoice.to.archives’ and an HTML as well with name ‘AF.Admin.Sending.Invoice.To.Archives’.

When I need to update the title as ‘Sending Invoice to Personal Archives’, how do I do that? I guess I MUST NOT EDIT THE ATTRIBUTES of existing xref as it is linked to many titles/tasks/topics in the documents. Should I create a new xref for this updated heading? And how do I handle existing HTML, should I change its attribute? This is really confusing. I tried but it was messed up.

Please HELP ME, and TONS OF THANKS in advance.

Our company – Basware Corporation requires technical writers who have around 1 year of experience in developing end-user documentation for software. The position is based in Chandigarh (Rajiv Gandhi Technology Park) – IT Park. Please visit http://www.basware.com to know about the organization.

I must say that it is an excellent – once in a lifetime opportunity for budding technical writers. Our documentation process is extremely good and we work on latest technology set. Basic knowledge of documentation process is required and knowledge of XML will be an added advantage.

Life in Shimla…

Basware brought me to Shimla and it has been a lifetime experience spending 6 weeks here in queen of hills. The air is fresh as compared to in Chandigarh, people are more friendly, public transport is better and eh, the lush green surroundings…

The downside is getting accommodation (house on rent, or good PG), and space for parking. Nonetheless, it is indeed a beautiful place, and it can surely add years to one’s life.

Saying Goodbye

It was eleven in the evening and the marriage party was in full swing. We were in North Park, Panchkula. Almost everybody was there – some of us had planned to stay together, others had decided to leave, and rest had not thought anything. It was a coincidence that we were brought together for the last time by Seema’s marriage, Seema who was most senior in the group in terms of time we had spent while working together.

“Congratulations!” said Aarti, “Shruti told me about the book.”

“Thank you,” I replied, “I’ll send you a copy.”

“Thanks,” and both moved ahead.

Ravdeep and I were together most of the time, though within the group. The first time a waiter offered us wine, I told myself that I would not have it today. Normally I avoid it even if it is a marriage party but that evening I felt tempted. Next time he came to me, Sandeep picked one, his second. As I was thinking, he laughed away, “Is it because it is Tuesday?”

I found a valid excuse. “No kidding,” I told him.

Everybody heard our laughter but soon it died.

“Is it the last time?” I thought, and perhaps Ravdeep was also thinking the same. We glanced at each other as if we were asking each other too. In some time, I saw people dancing and I felt like dancing there.

The orchestra changed its color and the dance intensified. The music got louder and I felt as if all of us were soaked in the atmosphere. But there was less fun that day and fewer smiles were being exchanged.

All those moments that we shared when we had laughed together – inspector eagle parties, birthday and milestone bumps, lunch duties, Mathi’s maaros, Shruti’s however, Jatinder’s do mare kann te (patient energy), Sanjay’s lekin and see! (logic), Ravdeep’s daily laughs, Chander’s but why (cold logic), Geetanjali’s mirchi (lunch), Ranjana’s that’s ok, Hariharan’s boss, Suresh’s NAV, Vikas’s politeness, Seema’s timesheets and sitting in her chair with folded leg(s), and my chai.

At around twelve, it was almost the time to say goodbye. I thought I would say – Stay in touch, write to me, I’ll mail you, sms me – but the mood was different. It certainly didn’t reflect how sad we were, but the precision of sentences used couldn’t hide it either.

As I felt the party was getting over, our group began to scatter. There was not much time for saying anything, rather not much to say. I thought I would cry and I should have cried. Ravdeep said that he didn’t feel like leaving from there. Shruti and Aarti left. Followed by Suresh and Hari. Sanjay had already left.

I sensed how difficult was for some of us to say goodbye and how easy it was for others. As if it was only the state of mind. Was it? Some of us were smiling by heart, and some were pretending to be, and the rest not even pretending.

Mathi and Chander wanted to leave together with us both but we were willing to stay. We wanted to wish final goodbye to Seema but she was not there. I congratulated Anu, her sister who looked more happy than most of us. She told me that Seema would take some time to come for ‘phere’. I realized that we should leave.

I thought of Seema, who taught me what a technical writer is, who was getting married and would soon board a flight to US, don’t know why making me feel that I would never see her again.

So, I was reluctant to say goodbye. You change jobs and suddenly you start loving new friends, without wishing the love for old friends to die. I guess Ravdeep was also feeling the same, wondering that things would never be same again.

I saw different goodbyes that evening – Shruti’s was brief, Aarti’s was friendly, Sanjay’s was missing… but mine was silent, and Ravdeep’s was silent. As I walked back to the car, I felt my feet struggling to support my mind. Others had driven back leaving me behind there, struggling to say goodbye. I carried it home and felt that I should have left it there only.


Q. Who is the GM of Hewlett Packard (hp) ?
A. Rajiv Gupta
Q. Who is the creator of Pentium chip (needs no introduction as 90% of the today’s computers run on it)?
A. Vinod Dahm
Q. Who is the third richest man on the world?
A. According to the latest report on Fortune Magazine, it is Azim Premji, who is the CEO of Wipro Industries, and is an Ismaili Muslim.
Q. Who is the founder and creator of Hotmail
A. Sabeer Bhatia
Q. Who is the president of AT & T-Bell Labs (AT & T-Bell Labs is the creator of program languages such as C, C++, Unix to name a few)?
A. Arun Netravalli
Q. Who is the new MTD (Microsoft Testing Director) of Windows 2000, responsible to iron out all initial problems?
A. Sanjay Tejwrika
Q. Who are the Chief Executives of CitiBank, Mckensey & Stanchart?
A. Victor Menezes, Rajat Gupta, and Rana Talwar.
Also: We Indians are the wealthiest among all ethnic groups in America , even faring better than the whites and the natives. There are 3.22 millions of Indians in USA (1.5% of population). YET, 38% of doctors in USA are Indians. 12% scientists in USA are Indians. 36% of NASA scientists are Indians. 34% of Microsoft employees are Indians. 28% of IBM employees are Indians. 17% of INTEL scientists are Indians.  13% of XEROX employees are! Indians.

HISTORY FACTS ABOUT INDIA .
1. India never invaded any country in her last 1000 years of history. ( ? )
2. India invented the Number system. Zero was invented by Aryabhatta.
3. The world’s first University was established in Takshila (in Taxila, Pakistan) in 700BC. More than 10,500 students from all over the world studied (more than 60 subjects. The University of Nalanda built in the 4th
century BC was one of the greatest achievements of ancient India in the field of education.

 

4. According to the Forbes magazine, Sanskrit is the most suitable language for computer software.
5. Ayurveda is the earliest school of medicine known to humans.
6. Although western media portray modern images of India as poverty striken and underdeveloped through political corruption, India was once the richest empire on earth.7. The art of navigation was born in the river Sindh 5000 years ago. The very word ‘Navigation’ is derived from the Sanskrit word NAVGATIH (port for boats-rough translation) 

 

8. The value of pi was first calculated by Budhayana, and he  explained the concept of what is now k! nown as the Pythagorean Theorem. British scholars have last year (1999) officially published that Budhayan’s works dates to the 6th Century which is long before the European mathematicians.
9. Algebra, trigonometry and calculus came from India . Quadratic equations were by Sridharacharya in the 11 th Century; the largest numbers the Greeks and the Romans used were 106 whereas Indians used numbers as big as 10 53.

10. USA based IEEE has proved what has been a century-old suspicion amongst academics that the pioneer of wireless communication was Professor Jagdeesh Bose and not Marconi.
11. The earliest reservoir and dam for irrigation was built in Saurashtra, (Gujarat, a state north of Mumbai)
12. Chess was invented in India.

14. Sushruta is the father of surgery. 2600 years ago he and health scientists of his time conducted surgeries like cesareans, cataract, fractures and urinary stones.. Usage of anaesthesia was well known in ancient India .
15. The place value system, the decimal system was developed in India in 100 BC.

 

Quotes about India:
We owe a lot to the Indians, who taught us how to count, without which no worthwhile scientific discovery could have been made. Albert Einstein
India is the cradle of the human race, the birthplace of human speech, the mother of history, the grandmother of legend and the great grand mother of tradition. Mark Twain

PROUD TO BE AN INDIAN

The first few months at first job as technical writer are confusing since you are not always sure what exactly you are supposed to do. Your role is less significant in the company; not all information regarding the project is communicated to you, and you rarely sit late nights or miss your lunch.
It is only after about a few months of experience, when you have developed at least a couple of documents that you begin to understand the finer points of technical writing. Once you know your job, and are comfortable doing it, it gets extremely important to raise the bar.
This is the time when you should learn the difference between a poor document, an acceptable document and a good document, and make required improvements.
Have a look at an example of poor documentation.
Raise the bar...

Raise the bar...

This is an example of poor documentation because of following reasons.
Rectangles in Red color: The space between image and text is inconsistent. It looks as if the image is centrally aligned in a specific area for all three points. One, a centrally aligned image does not look good since the paragraph starts at different positions wrt left alignment. Two, it leaves the space between image and text as unequal.
Circles in Green color: The points in list terminate inconsistently. One of the points does not end with a full stop, while others do.
Circle in Blue color: There is double space between the two words. A technical writer should take not more than 20 seconds to point out if there is a double space anywhere in one page of a document.
Circle in Yellow color: The word the is used unnecessarily, at many places. Though the use of the is very tempting, it is generally not required most of the times.
Circle in Brown color: A technical writer must avoid the continuous form of verb such as clicking. A user control such as a button does not allow a user to do something. Use enables rather than allows. Use words that are devoid of feelings. For example, use required, and not desired.

 

*****************************************************************************************
STC Learning Session on June 28, 2008 @ Chandigarh

The India chapter of the Society for Technical Communication is pleased to announce the first learning session for technical communicators on June 28, 2008 @ Chandigarh.

To know more about STC India, please visit www.stc-india.org

*****************************************************************************************

Agenda
———–

10.00 AM to 10:30 AM
Registration and Introduction

10:30 AM to 11:30 AM
Session 1: “Blogs, RSS and Folksonomies: An Introduction to Web 2.0″ by Saravanan Manoharan from MTree Software


About the session
————————–

In this session you can get to know the basics of Web 2.0 and its relevance in Technical Communication.

You can also get some insights on:

*   Blogs – How to create a company blog in five easy steps
*   RSS – How to use RSS in your blogs
*   Folksonomies – How to use Folksonomies effectively

———————–

Saravanan Manoharan is a Computer Science graduate, currently working with Mtree Software as a Technical Writer. He has around six years of experience in Technical Communication. Saravanan is also pursuing the PGPBM for Working Managers (WMP) course conducted by IIM Lucknow, Noida Campus. His hobbies include networking, playing drums, learning new languages, playing all sort of sports, and reading varieties of books.

——————————————
11.30 AM to 11.45 AM
Tea/Coffee/Snacks break

11.45 AM to 12.45 PM
Session 2:  Session on “Teaching Technical Writing” by Amit Das from Chitkara University, Chandigarh


About the session
—————————

In this session, Amit would be discussing the following:

* Technical Writing: Perception and Challenges
* Technical Writing Process
* Resources available for Technical Writers
* Growth in Technical Writing


Amit would also be informing the audience about the latest Technical Writing books that are available and at the end he would like to discuss with the audience and get inputs for an ideal Technical Writing Syllabus.
—————–

Amit Das works as a Senior Lecturer in Chitkara Engineering College, Chandigarh. He is a Post Graduate in English, ELC and has a certificate in Documentation. He has varied experiences starting from working in an NGO to Documentation Manager. Currently, Amit is teaching Technical Writing and College Writing for George Brown College, Toronto in Chitkara Engineering College, Chandigarh

————-

12.45 PM to 01.00 PM
Q&A and Closure


Venue
———-

Seasia Consulting is sponsoring their venue for the First STC Chandigarh Learning session on June 28, 2008.

Seasia is one of the fastest growing IT services companies in the Chandigarh region. Seasia exclusively provides offshore development services to Saber Corporation, Portland, USA (www.sabercorp.com). In their work together, Saber and Seasia have demonstrated their close alignment in their values, work ethics and passion for excellence. Saber’s corporate mission is brief and straightforward — “To be the premier provider of software products and services that enable government to better serve citizens.” Saber’s demand for excellence coupled with Seasia’s capability and resourcefulness have combined to help Saber fulfill its commitments to its customers. Saber’s incredible growth rates also create a high rate of growth for Seasia as well as provides employees of Seasia with both temporary and long term career paths into Saber in the US.

For more details about Seasia, please visit http://www.seasiaconsulting.com


Address
—————

Seasia Consulting
SCO 40,41,42, Sector-26
Madhya Marg
Chandigarh – 160019
India.
Phone #: +91-172-5056600


How to get to the venue
———————————-

Please refer the map here:

http://www.wikimapia.org/#lat=30.7249041&lon=76.8074799&z=18&l=0&m=a&v=2.

Maximum Number of Participants:
————————————————-

This session is limited to 30 participants only.


Registration Details:
——————————
To confirm your participation, please send your contact details (Name of the Company and Contact Number) to Saravanan Manoharan at sara.techwrit@gmail.com and cc to Vinish Garg at vinishjg@gmail.com

Please do not inquire about the session on this mailing list. Your participation is confirmed only if you receive a confirmation mail from Vinish Garg or Saravanan Manoharan.


Participation Fee
————–

Rs. 150.00 for non-STC members. Free for STC members (Please quote your STC membership ID while sending the mail).


Please note the following:

- All participants (STC members or Non-STC members) must register and get a confirmation mail from Vinish Garg or Saravanan Manoharan on or before June 25, 2008.
- Non-STC members can pay the participation fee at the session.

 

 

Thanks and Regards
Vinish Garg
Volunteer (Chandigarh)
STC India Chapter
98550 63463
More details are available at: http://rurbricate.wordpress.com

Democracy

It was only last year that we proudly celebrated India’s 60th Independence Day. Many historians, writers, bureaucrats and, even media painted it as a historic day. And barely 10 days after the historic days, a bomb blast in Hyderabad had rocked the country. Many such attacks have followed – the most recently in Jaipur.

For once, we see the headlines as a few people have been killed and injured, and everybody gets back to one’s work in a few days. Well, as Navjot Singh Sidhu says – ‘Statistics are like bikinis; they reveal less but conceal what is vital’. Whether a blast kills 4 persons, or 14 or 40, the fact is that it is violence, and it is direct attack on one’s most fundamental right on earth – the right to live. Nothing less and nothing more.

I have been watching The Big Fight on NDTV 24X7 and many times, I wonder how the times have changed. People talk about Terrorism, Education System, Pepsi and Cola, Dowry, AIDS, Fashion, Religion and Homosexuality, with exemplary energies and emotions, so much so that it feels as if they (and we all) are directly affected by the issue being discussed. Quite astonishingly, majority of the crowd includes young people – students, young entrepreneurs and executives. This is an awakened urban middle class of India, who is glitzier and happier with healthier and richer life style, has better access to information and entertainment, is more aware of almost every aspect of life and society, and is more ready to speak on any issue, than ever before.

And suddenly the headlines at the bottom of TV screen tells about the bomb blast, as if the lives of 40 people too scrolled from right to left, in a flash. It is shattering for everybody, me, you and the country that turned 60 a few days back. Dead bodies of people lying all over the place made me wonder that times haven’t changed. Some sections of our society are using the same energy and emotions for entirely different purposes – to spread terror, violence, anger, panic, desperation, hence vitiating the atmosphere. These are the people whose minds have gone rotten and souls have degraded, psychologically, and I guess biologically as well.

Picture one – India’s economy has grown (sometimes amazingly) in the last few years. We have seen improved GDP, relative boom in IT and even in Real Estate; our strides in Technology (Space, Telecom and Bio), Cinema, Fashion and Sports. Picture two – there has been marked increase in the frequency of terrorist attacks and their targets have moved out of Punjab or Kashmir to Delhi, Varanasi, Mumbai and Hyderabad. As the world’s largest democracy, how do we set up our image – a country which is a political example to other developing nations who confront internal politics, racial divisions, illiteracy, corruption and poverty, to maintain the phenomenal growth that we have achieved? Or a country that boasts of world’s fourth best army with a sound defense systems, but has witnessed nearly 40, 000 killings in Kashmir alone, thousands in Punjab earlier, and who has almost been a mute witness to terrorist attacks for nearly sixty years?

The progress that we are proud of today has only benefited a small privileged section, or to an extent, some percentage of popular middle class. You can not evaluate governance on a few specific and urban success stories, a ‘cyber city’ in Hyderabad or Bangalore. In fact, it has marginalized the poor, as the rising incidents of farmers’ suicide and growing disparity between rural and urban people are a testimony to it.

How does it impact our lives? And how do these terrorist attacks affect our lives? After every major terrorist attack, our leaders condemn the attack. Earlier it was for Punjab, then for Kashmir and now for anywhere in the country. Some statements are soft, and sometimes they are strong, but the benefits are nil. Why so? Because, principally, the political will is not there, and wherever it is, it is not consistent.

Barring a few sections, the mindset of every common man is same today. Everybody is upset either when the price of petrol is hiked by 2 rupees or when pizza gets costlier by 20 rupees; either when an encroachment is demolished from a store, or when the same shopkeeper is caught while selling adulterated food; either when a man is asked to deposit rupees sixty thousand as donation to get his kid admitted to a reputed school, or when the same man demands rupees ten thousand to pass a drawing for a house. The fears and insecurities are same, only the scale is different, and which doesn’t matter.

The urban middle class of India, who glued to TV sets on 11 July or 8 September or on 25 August last year, or on 13 May last month, including me, feels concerned but don’t know what it can do. We have grown in our standard of living, are more aware of issues that bother us, are more able to stand and be counted than our previous generations, but we lack political empowerment. Our political system has lost its credibility, so much so that we do not caste our vote, our very fundamental right to elect the leaders that we want ourselves to be ruled by. Our faith has been windswept by the sullied value system of our politicians. By political empowerment, I don’t mean that we should hold protest meetings, or take candle march in streets, or raise slogans. It begins with being aware of our rights. Our power. Our strength. Our right to vote.

As the world’s largest democracy, we, the people of India can make a difference, by using the very basic right that we have – our right to vote. Our educated and economically prosperous middle class is India’s biggest asset, but our resistance (call laziness) and our lack of interest to cast our vote is the biggest obstacle. And the root cause of many other critical issues is same – our political system. It is said that – an inefficient government is not caused by people who vote to wrong people, but by those who do not vote. As a result, our leaders are elected to a position where first they asked us for a vote, and when elected – they laugh at us and they use us, and in the end they are laughed at and are used by those who take advantage of our sleeping will and politician’s cult will.

The foundation of democracy is right to vote, and right to get elected; but when the former is not being exercised properly, the use of later is abused, as we have seen. And voting the current political system out of the country’s political setup is the one and only step to proceed. It is essential to evolve a new dynamic political ideology, not for those who run our country, but for we, the people of India, to deal with those who run us, and then to deal with those, who run the people who run us. But how do we do that. It requires a common pledge, a desire and a certain degree of political empowerment to take such a decision. One of the options is that we start voting with interest, and with awareness, to people with credibility, or if we do not find anybody good enough to be voted, none of us should vote – not a single vote. When the votes will be counted in hundreds or thousands instead of thousands or lakhs, our leaders and those who had been leading our leaders will realize that we have awaken, and changes will happen.

It is time to reengineer democracy. Reengineering? A few weeks back, a came across a few lines on reengineering democracy. These are penned down by Efraín María Martresa as:

Let’s Vote for Issues, Not for People!
We are used to believe that democracy is to elect
our leaders, by means of our votes.
And according to the candidate’s platform and programs,
we decide what we want.
But:
What if we train, prepare, our civil leaders
and just vote to decide important issues?
Of the many advantages, we can cite (and not limited to):
Government doesn’t stop in pre-election periods
Lobbyists and special interest groups shouldn’t be that powerful
Use new technologies to cast our votes, whenever needed
Avoid new governments to learn as they go

We don’t have any formula here, we are trying to start a discussion so we, the people, can decide what we want and how we want it implemented.

To start, and maybe, we may model it likewise the training we give to the military, with ranks and different courses and specializations, like economics, government, environment, education, health, etc after graduating, and just giving a preliminary idea, they can start a career in government and according their experience, we give them more training to prepare them for more important tasks.
Beside having special institutions to do this training, we can admit professionals already trained, like
attorneys, economists, physicians, etc. and have them trained in specifics of government.
Again, this is just an input, every country should decide a final system which, of course, will take years to implement and adjust as we advance.

The author suggests that we should vote for issues and not for people. I believe that in a country as diverse and vast as India is, voting for people should be continued… but along with voting for issues to be resolved and within voting for time frames, based on certain factors.

Is it too utopian? May be. Or perhaps not.

Technical Writers are creative people. Shocked? They have to describe a dialog box in the same manner, again and again. The have to say ‘Click on Save button to save the changes’. No other option. Then where’s the scope of creativity? Ah, you saw them using Photoshop? Or SnagIT? Hey, again they were not allowed to enter into the image, only crop it since designer is on leave and the document is got to be released.

Hmmmmm. Developers wonder (sometimes admire) as “I too wrote the same point, used almost same words; however, your draft looks better. You are really creative people.” Is that true?

Many technical writers want to agree with this developer but internally, they feel that there is nothing creative about their job. They are made to think and write in a specific way. That’s how the client demands. That’s what the organization hires you for. And that’s what tech writers have learnt. That’s how the tech writing community expects.

I personally believe that tech writing is definitely about creativity. True that tech writers do the same thing in the same way, they can always explore different ways to convey the same message. Developing or updating templates offer them extensive opportunity to be creative. Its fun and its challenge, and the more you love your job, more you can be creative. When you direct the designer three times to crop the image, not that way but I want it this way, na not like this but make it without borders, isn’t it thinking creatively?

Of late, XML and structure authoring have threatened to limit the scope of being creative, yet, I believe that tech writers are creative. They lend words to thoughts. They lend visualization to imagination. And they lend smiles when a user finds the required information – clear, complete and correct. And I bet you can’t do that without being creative.

« Newer Posts - Older Posts »