The first draft of a document is suppose to have bad grammar, incomplete sentences, and a lack of overall refinement. Make sure you focus on getting ideas out of your head and onto “paper” instead of trying to make your first draft your only draft!
Contrary to popular belief you should spend more time making sure your documentation contains clear concise language rather than spending your time buried in a thesaurus.
Finding a balance between meaningful content and flow can be difficult when drafting a technical document. Once I begin proof reading my work I always ensure that I’m consistent with tense and I make sure I’m writing in the third person. While it may not be necessary to write in third person it is important to be consistent with your point of view (e.g., first person, etc.).
Documenting your work is important for more than one reason. Aside from the obvious benefit of providing your peers with an insight into your thought process - effective documentation gives you the opportunity to double check your work. If you have a hard time documenting your work using simple, concise statements then maybe you need to simplify your approach so that it’s easier to explain.
Taking the time to care about documentation up front will save you time when you need to communicate your approach to your peers.
Did you just have an interview or are you getting ready to go on one? Don’t forget to get the contact information for the people you meet during the interview. Send an email to thank them for their time. Add a personal touch to the email but be sure to keep it concise…the thought will go a long way and it’ll keep the lines of communication open.
Dressing for success doesn’t mean you need to leave the house in a suit and tie every morning. Keep your individualism but be sure to put your best foot forward. If you feel great about how you look you will exude confidence and be taken seriously by your colleagues.
Practicing a presentation before you deliver it isn’t stupid. Flying by the seat of your pants is. Plan out what you want to say and anticipate your audience.
When authoring a technical document make sure you take the time to read and comprehend what you write before you call it complete. It may seem like a waste of time but you’ll save yourself the headache of explaining what you intended to say to your peers.