Showing posts with label Technical Writing. Show all posts
Showing posts with label Technical Writing. Show all posts

Resume

A resume ( French word ) is a document used to present past/present backgrounds and skills of a person. Resume is mostly used to secure new job/employment.

A resume is the first impression of your capabilities and competence on your prospective employers. Resume is like an advertisement of your skills. While presenting your resume you will to employer you are actually trying to sell yourself.

There are two types of resume

1) Reverse Chronological Resume Reverse chronological means that the most recent work experience appear first and the oldest appear at the end. This is a standard format of the resume. One will write a reverse chronological resume if
  1. If he has got a formal education/degree/certificate, related to the field he wants to enter.
  2. If he is a fresh graduate.
  3. if he is planing to stay in his current profession.
2) Functional Resume A functional resume is an informal type of resume. In this type of resume one may show experience in the form of clusters. one may also omit dates or past employer names. One will write a functional resume if,
  1. he is trying to enter a non traditional field
  2. he is trying to enter a specific field after a long time, usually after years.
  3. he has not formal education related to the field he is trying to enter.
Essentials of resume No matter which type of resume you write, ou must include the following stuff in your resumes. 
  1. Identification this include your name, full contact information i.e. phone number,address, email etc.
  2. Career Objective This part of a resume is one of the most focused are of resume. It must represent your true picture i,e capabilities, skills, strengths etc. This part may not exceede than 2-3 lines.
  3. Summary of Qualifications This part will include a summary of your qualifications, including skills, abilities, strengths attributes etc.
  4. Job/Employment This part will include job title, company name, your responsibilities and time period.
  5. Education This will include your degree/certificate and their issuing authorities and their dates.
  6. Personal skills This part will represent your unique personal skills for example Java, HTML, PLC etc..
  7. Affiliation This part will represent your affiliations with different societies, clubs, communities etc. 
  8. References mention referees in this part remember Do not write stuff like 'will be provided on request'. instead ignore this part if you have no referee.
Tips for winning Resumes Some tips for the winning resumes are
  • Resume is just like your advertisement or a brousher so make it as beautiful and attractive as you can. Organised each of your detail in a very simple and good manner.
  • Try to be different from other candidates.
  • Always thinks from the employer prospective. write what they want not what you want.
  • Avoid long sentences.
  • Use power verbs like,
               Acomplished     achieved           build          created              designed          earned    
               improved           gained              led              managed           planned           presented
               resolved             sold                 supervised   trained              installed          initiated 
  • Most of the resumes start with such lines,
                Getting an opportunity in a dynamic organization where I can ......
                Joining an organization where I can apply my skills and ………

          These type of line kills your impressions. Your employer don't care about your objective he
          care about only his objective. So write employer friendly line.
  • Proof read it many times. Check spellings and grammatical mistakes.
  • Remember what Penelope Trunk said,
“A résumé isn’t an autobiography, it’s a marketing document. So the goal isn’t to tell every single
thing about yourself, but rather to get an interview. This is why a résumé should be a tease, not
treatise.”

Resume Templates

Helpful info
For more guidance read these book 

How to write a MEMO and official Email

Memo
The word “memorandum” means something that should be remembered. A Memo is a short written communication with in the organization that is often used to provide information or ask for some form of action to take place.

Parts of a Memo
     Heading Date   (Complete current date)
                             To (Readers name and job titles)
                             From (Your name and job title)
                             Subject (What the memo is about)

     Opening         State purpose of Memo, give facts.
     Summary         Explain situation in more detail.
     Discussion Any other information you need to present?
     Closing Make a courteous closing statement.
     Attachments    Include any as needed.


While writing memo
  1. Be specific.
  2. Start by stating exactly what it is you want.
  3. Keep memo short (Under one page).
  4. Use bulleted list.

Example of MEMO

_______________________________________________________________________________________________

PEL Limited

To:

Marketing Manager

From:

CEO, PEL Limited

Date:


April 25, 2015

Subject:

Meeting regarding Marketing Strategy of a New Model of Refrigerator PEL-128.



It is to inform you that a meeting is held over discussion on marketing strategy of a new model of PEL Refrigerator PEL-128, which is going to be launched on 12 June, 2015.

You should come up with a complete report of marketing strategy of this model. You should also have to brief me over marketing strategy. On the basis of these I will give you suggestions and orders to improve its marketing.

Make sure your presence on May 10, 2015 in CEO office at 9:00 PM.


______(Sign Here)_______


________________________________________________________________________________________________


E-mail Email is Electronic Mail, written for a wide range of audience and subject line.

Parts of email

To                  (Readers name and job titles)
Cc                   (Complementary copy)
Subject             (What the memo is about)
Opening            State purpose of Memo, give facts.
Summary          Explain situation in more detail.
Discussion Any other information you need to present?
Closing     Make a courteous closing statement.

   Writer Info
  Attachments Include any as needed.


While writing E-mail
  1. Recognize your audience.
  2. Provide an effective subject line.
  3. Keep your email brief so that user do not have to scroll.
  4. Use highlighting techniques.
  5. Be careful while sending attachments. There is always a limit for attachment.

How to write a technical report


A technical report is a formal report designed to convey technical information in a clear and easily accessible format. The main objectives of technical writing are
  • Clarity 
  • Conciseness 
  • Accuracy 
  • Organization 
  • Ethics
1.Clarity Clarity means to make your documents clear and easy to read. For this you have to
  1. Provide specific details. For this purpose you may bulletize your information. This document is a good example of bulleting the information. Try to avoid abstract words/phrases like any, many, few, recently, soon, early etc. 
  2. Answer the reporter's questions. You may first ask a reader to question the writing content. This will help you point out the list of questions which a reader can ask. Then make a new draft and add what’s missing. 
  3. Use easily understandable words. E.g. use the word ‘wrong’ instead of ‘erroneous’ Just think that you are writing for a lay man. Don’t use abbreviations, acronyms or jargons. 
  4. Use verbs in the active voice. 
  5. Avoid Obscure words. Words which are not relevant to the content or words which may create ambiguity in reader’s mind. 
  6. Don’t follow duplication of words. E.g. I will any way or somehow do it. Here you can use either any way or somehow.
2. Conciseness Your writing should be short precise and to the point. It will help to save your writer as well as reader’s time. To achieve this you have to
  1. Limit paragraph length. Long paragraphs may irritate and confuse your readers. 
  2. Limit word and sentence length. Short words and sentences are easy to read. 
  3. Avoid a high fog index. In linguistics, the fog index measures the readability of English writing. 
  4. Use meat cleaver method of revision. In this method you simply cut a long sentence or paragraph in half or thirds, to avoid it being too long where it is difficult for readers to understand it. 
  5. Avoid shun words like accommodation, decision, admission, permission, occasion. 
  6. Avoid camouflaged words. E.g. ‘It was my duty to make a determination of any damages’. Instead of this you can say, ‘It was my duty to determine any damages’. 
  7. Avoid the expletive pattern 
  8. Omit redundancies. 
  9. Avoid wordy phrases.
3.Accuracy To avoid grammatical errors follow the following tips
  1. Let someone else read it. Other may arise questions which may improve your document. 
  2. Use gestation approach. 
  3. Let a critic to read your stuff. He will always give you a good advice. 
  4. Present your document for proofreading. 
  5. Read backwards for error not for content. 
  6. Read one line at a time. Human eye can’t search out many lines at a time. 
  7. Read long words syllable by syllable. 
  8. Use computer spell checks. 
  9. Check figures, scientific and technical equations, and abbreviations. Figures really matters. It provides your reader facts and you don’t want it to be wrong. 
  10. Read it aloud. 
  11. Try scattershot proofing. 
  12. Use a dictionary. It provides you synonyms, antonyms etc. and increase your vocabulary.

4. Organization To guide your reader, use organizational strategies such as
  1. Spatial. 
  2. Chronological. Try to arrange your words in order of its happenings. This will develop a sequence and will make the document interesting and easy to read. 
  3. Importance. The arrangement may also be in terms of importance. One will like to place important stuff on the page where it can be seen at a first glance. 
  4. Comparison/Contrast. 
  5. Problem/Solution Identify the problems and suggest suitable solutions.

5. EthicsTo be a responsible technical writer:
  1. Check your actions against legal, practical, and ethical concerns. Being a Muslim or a good human being we have to write things which promote goodness in the society. 
  2. Follow strategies for making ethical decisions: define the problem, determine your audience, maximize values and minimize problems, consider the big picture, and write your text.

How to Write a research proposal

When you are applying for Master, PhD, any research or a study scholarship, you are expected to submit a "detailed and precise description of study or research proposal as well as information on any previous study or research projects of particular relevance." in order to prove your competency.

The purpose of the proposal is to ensure that
  • The candidate is fully interested and committed towards the mentioned area.
  • The candidates have done sufficient reading/research in the area of their interest.
  • They have thought about the issues involved and are able to provide more than a broad description of the topic which they are planning to research.
Parts of the Research proposal

Title Page
  • Personal data (name, academic title, your position at your own university, date of birth, nationality, your contact information, institutional contact.
  • Title of your planned research report. Words in the title should be chosen with care and their association with one another must be carefully considered.
  • The title should be brief, it should be accurate, descriptive and comprehensive, clearly indicating the subject of the investigation.
  • Indicate a realistic time frame toward project completion, followed by the name(s) of your supervisor(s), the university department where you hope to do your research.
  • Refer to successfully funded projects to determine whether your topic fits with the granting organization's mission and to mimic their title/proposal structure
Abstract statement of the research project
This one page summary focuses on the research topic, its new, current and relevant aspects. This area should be very precise and should not be more than one line. Try your best to narrowing the topic.Watch out for clarity. Abstract is the first impression of your intentions. You never get a second chance to make a first impression

Literature Review
  • The literature review serves several important functions:
  • Ensures that you are not "reinventing the wheel".
  • Gives credits to those who have laid the groundwork for your research.
  • Demonstrates your knowledge of the research problem.
  • Demonstrates your understanding of the theoretical and research issues related to your research question.
  • Show your ability to critically evaluate relevant literature information.
  • Indicate your ability to integrate and synthesize the existing literature.
  • Provide new theoretical insights or develops a new model as the conceptual framework for your research.
  • Convince your reader that your proposed research will make a significant and substantial contribution to the literature,
Your preparations
  •  Summarize the most important impact of your own work on the topic.
  •  Attach copies of your own publications that might be seen in relation to your research project.
Objective of the research project
  • Give a concise and clear outline of the academic objectives that you want to achieve through your project.
  • Your proposal needs to show why the intended research is important and justifies the search effort. Here you outline the significance of the topic.
  • All research is part of a larger scholarly enterprise and candidates should be able to argue for the value and positioning of their work.
Outline the project
This is the central part of research outline.
  • Detail your research procedure within the given time.
  • List sources and quality of evidence you will consult, the analytical technique you will employ.
  • Depending on the topic, suitable research strategies should be defined to ensure that enough and adequate empirical data will be gathered for a successful research project.
  • Describe the intended methods of data gathering, the controls you will introduce, the statistical methods to be used, the type of literature or documentary analysis to be followed, etc.
Timetable
Develop a time table, indicating the sequence of research phases and the time that you will probably need for each phase. Take into account that at this stage, it can only be estimated, but make clear that you have an idea about the time span that will be needed for each step. Develop a good tentative plan.

Selective research bibliography
List academic works mentioned in your research outline as well as other important works to which you will refer during your research

Attachments:
List other documents attached to your proposal. References, CV, etc.

Editing:
Once you have finished the conceptual work on your proposal, go through a careful editing stage. 
  • Proof read it.
  • Show it to experts near by you. If there are none show it to your teachers and friends.
  • Write several drafts to make improvements.

How to write a promising CV (Curriculum Vitae)

Writing a persuasive CV is a very difficult task for the newbies. Today we are going to tell you how to write a perfect and effective CV.

A CV is like an advertisement of your skills. With your CV you actually try to sell yourself to the employer. So make it as eye catching as you can. Some of the requirements of a successful CV are
  1. Keep it up to maximum of two pages of A4 size. The first page will include your profile, while the next one will show your skills. 
  2. Include your personal information such as contact number address etc. in your CV. A good place for personal information may be top right or top left of the page. 
  3. Below Personal information, add a personal statement. A personal statement will define you. So try hard to write the most effective personal statement. The personal statement should not be more than two lines. 
  4. Next is to write education. Always write your education in reverse chronological order. 
  5. Highlight your achievements in the upper middle region of the page. 
  6. Double check it and proof read it. Always compare it with good CV’s and constantly improve it. 
  7. Remember three things are necessary for an irresistible CV, they are
* Presentation
* Presentation
* Presentation





William G. Mines Junior said once“You’re on the road to success when you realize that failure is merely a detour.” Always keep this in your mind.

Now its time to tell you how my cv looks like...!!



If you have any suggestions or queries, Please don’t hesitate to share.
Hope that this small effort of our team will help you.