technical writing tips and articles for companies and individuals

tips

Technical Writers Should Have Multiple Personalities

Posted by on May 12, 2011 in proposal writing, technical writing, tips | 1 comment

Technical Writers Should Have Multiple Personalities

Tweet I’ve always said the coolest part about being a writer in the technology field is that you are a “Jack of all Trades.” You have to be in order to keep up with the Developers, Project Managers, and Business Analysts. This is what makes us so valuable, and keeps the phone ringing when we have our resumes out there. We have touched all kind of documents, even ones that really had nothing to do with IT or proposals. This is why we...

Read More

Using Mind Maps to Help Your Writing

Posted by on May 4, 2011 in proposal writing, technical writing, tips | 1 comment

Using Mind Maps to Help Your Writing

Tweet

Read More

Outlines Save You Tons of Time

Posted by on May 2, 2011 in blogging, proposal writing, technical writing, tips | 0 comments

Outlines Save You Tons of Time

Tweet Outlining works for any size document.  From a quick blog post to an 100-page proposal, outlining can save you tons of time.  Creating a detailed outline also helps in putting structure in the document’s logic as well. Two of my favorite types are a linear outline and mind mapping.  Today, I will talk about a linear outline. Before Outlining Before beginning, you will need to really think about what is the main goal of your...

Read More

Using Acronyms and Abbreviations in Proposals and Tech Docs

Posted by on Apr 5, 2011 in proposal writing, technical writing, tips | 2 comments

Using Acronyms and Abbreviations in Proposals and Tech Docs

Tweet Acronyms and abbreviations are one of those things that I always see people getting wrong in documentation. When you are delving into a heavy technical jargon area, you can’t be lazy in defining them. This is especially the case when you have stakeholders, who are not in your organization and will be reading the document. Acronym vs. Abbreviation (or really Initialism) There is a very small difference between an acronym and...

Read More

Freelancers, Five Things to Think About Before Starting Work

Posted by on Mar 14, 2011 in tips | 2 comments

Freelancers, Five Things to Think About Before Starting Work

Tweet Once upon a time, there was a young writer who got her first freelancing gig. She was so excited because she realized that she was now her own boss. Verbally, Company X said that they would pay her this much, and that they would promptly pay after she wrote the proposal. Without a contract, the young writer got started. She worked hard to produce the best proposal for Company X. She turned it in and waited for feedback. Company X said...

Read More

Oldie, but Goodie: Reasons to Hire a Writer

Posted by on Mar 7, 2011 in tips | 3 comments

Oldie, but Goodie: Reasons to Hire a Writer

Tweet Save money by saving time – People tend to think that what a consultant is charging is ridiculous. However, take a step back and really think about it. You are now free to handle tasks that are more up your alley, while a writer, who is an expert on that kind of service, can work on documentation.  Also, you aren’t paying this person benefits, so that is another way that you are saving.  Additionally, instead of it taking you...

Read More