technical writing tips and articles for companies and individuals

Posts Tagged "documentation"

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

Creating a Style Guide For Your Documents

Posted by on Jun 10, 2010 in proposal writing, technical writing, tips | 0 comments

Tweet Here is my latest video stressing the importance of having a style guide for your company’s documentation. A style guide makes it easier to start writing and editing your documents before giving it to your team and clients. Tomorrow, I am going to follow up and go in-depth on how to actually go about it. The video provides a high-level overview of how go about it. Question is do you have a style guide for your...

Read More

How to Gather Requirements and the Documentation to Help You Do It

Posted by on Oct 2, 2009 in business analysis, technical writing | 1 comment

Tweet Requirements gathering can be tedious and frustrating, but if done successfully, you can ensure that the solution or product that you are building is a success.  Here is a video I created about the things I am learning while assisting a company gather requirements for a proposed system that they are going to build that will replace a system compiled of legacy systems (made out of Access..eeeek) and spreadsheets.     ...

Read More