<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0"
	xmlns:content="http://purl.org/rss/1.0/modules/content/"
	xmlns:wfw="http://wellformedweb.org/CommentAPI/"
	xmlns:dc="http://purl.org/dc/elements/1.1/"
	xmlns:atom="http://www.w3.org/2005/Atom"
	xmlns:sy="http://purl.org/rss/1.0/modules/syndication/"
	xmlns:slash="http://purl.org/rss/1.0/modules/slash/"
	>

<channel>
	<title>Proposal Writing Tips &#187; Style Guide</title>
	<atom:link href="http://www.proposalwritingcourse.com/tag/style-guide/feed/" rel="self" type="application/rss+xml" />
	<link>http://www.proposalwritingcourse.com</link>
	<description>Tips, Tools and Templates for Proposal Writers</description>
	<lastBuildDate>Thu, 27 Oct 2011 13:38:00 +0000</lastBuildDate>
	<language>en</language>
	<sy:updatePeriod>hourly</sy:updatePeriod>
	<sy:updateFrequency>1</sy:updateFrequency>
	<generator>http://wordpress.org/?v=3.2.1</generator>
		<item>
		<title>Warren Buffet Guide to Plain English Business Writing</title>
		<link>http://www.proposalwritingcourse.com/proposal-writing/using-plain-language-writing-techniques-to-write-better-proposals/</link>
		<comments>http://www.proposalwritingcourse.com/proposal-writing/using-plain-language-writing-techniques-to-write-better-proposals/#comments</comments>
		<pubDate>Mon, 20 Sep 2010 23:32:00 +0000</pubDate>
		<dc:creator>Editor</dc:creator>
				<category><![CDATA[Proposal Writing]]></category>
		<category><![CDATA[Business]]></category>
		<category><![CDATA[Format]]></category>
		<category><![CDATA[Proposal]]></category>
		<category><![CDATA[Style Guide]]></category>
		<category><![CDATA[Tips]]></category>
		<category><![CDATA[Writing]]></category>

		<guid isPermaLink="false">http://www.proposalwritingcourse.com/proposal-writing/using-plain-language-writing-techniques-to-write-better-proposals/382/</guid>
		<description><![CDATA[“For more than forty years, I’ve studied the documents that public companies file. Too often, I’ve been unable to decipher just what is being said or, worse yet, had to conclude that nothing was being said. If corporate lawyers and their clients follow the advice in this handbook, my life is going to become much [...]


Related posts:<ol><li><a href='http://www.proposalwritingcourse.com/proposal/warren-buffett-on-better-business-writing/' rel='bookmark' title='Permanent Link: What Warren Buffett Taught Me About Writing Executive Summaries'>What Warren Buffett Taught Me About Writing Executive Summaries</a></li>
<li><a href='http://www.proposalwritingcourse.com/proposal-writing/kate-winslets-7-secret-ways-to-revise-technical-documents/' rel='bookmark' title='Permanent Link: Kate Winslet&rsquo;s 7 Smart Ways to Read Business Proposals'>Kate Winslet&rsquo;s 7 Smart Ways to Read Business Proposals</a></li>
<li><a href='http://www.proposalwritingcourse.com/proposal-writing/super-glue-strategic-goals-to-business-development-activities/' rel='bookmark' title='Permanent Link: Four-Step Strategy for Better Business Proposals'>Four-Step Strategy for Better Business Proposals</a></li>
</ol>]]></description>
			<content:encoded><![CDATA[<p></p><blockquote><p>“For more than forty years, I’ve studied the documents that public companies file. Too often, I’ve been unable to decipher just what is being said or, worse yet, had to conclude that nothing was being said. If corporate lawyers and their clients follow the advice in this handbook, my life is going to become much easier. “ Warren Buffet</p>
</blockquote>
<p>In the late 90s, I found the Plain Language writing technique almost by accident. It’s also called Plain English, by the way. I was reading a lot about Warren Buffet a few years back and came across a nice, short document he wrote for the SEC. These are the folks who submit legal and business document to Wall Street when going on the stock exchanges. Buffet writes like he speaks. Direct, immediate and without pretension. </p>
<p>Ever read an <a href="http://www.berkshirehathaway.com/letters/letters.html">annual report from Warren Buffet</a>. Try it. Easy, isn’t it? Few successful business-people write so clearly. There is no pretension, no haughty references to obscure allusions and no strange acronyms. It’s all there in black and white. Here’s what Buffet had to say about other business writers, though,</p>
<blockquote><p>&#160;</p>
</blockquote>
<p><a href="http://www.klariti.com/Audience-Analysis-Templates/"><img style="display: block; float: none; margin-left: auto; margin-right: auto" border="0" alt="Audience Analysis Template - MS Word" src="http://www.klariti.com/images/Audience-Analysis-Template-7.gif" /></a></p>
<p align="center"><a href="http://www.klariti.com/Audience-Analysis-Templates/">Audience Analysis worksheets</a>.</p>
<p>From the handbook: </p>
<blockquote><p>There are several possible explanations as to why I and others sometimes stumble over an accounting note or indenture description. Maybe we simply don’t have the technical knowledge to grasp what the writer wishes to convey. Or perhaps the writer doesn’t understand what he or she is talking about. In some cases, moreover, I suspect that a less-than scrupulous issuer doesn’t want us to understand a subject it feels legally obligated to touch upon. “</p>
<p>He adds that “Perhaps the most common problem, however, is that a well-intentioned and informed writer simply fails to get the message across to an intelligent, interested reader. In that case, stilted jargon and complex constructions are usually the villains.”</p>
</blockquote>
<p>It’s a great read and you can download it here <a href="http://www.sec.gov/pdf/handbook.pdf">www.sec.gov/pdf/handbook.pdf</a> in PDF. </p>
<h3>Write Business Proposals in clear English</h3>
<p>So, with this in mind, I wrote this short guide to help you write Business Proposals in clear English. It explains how to prepare an business documents that readers can digest in one reading. That’s the acid test. They shouldn&#8217;t have to read them twice and three times to get the meaning. It also covers <strong>how to use Plain Language writing techniques to win more business</strong>, accelerate your tender process, and encourage staff to contribute to the overall tender process. </p>
<h3>1. Start Early</h3>
<p>Developing a Plain English document takes time – the first time!. For your first Plain English proposal, allow extra time to write, edit, and revise. Add more time than you would expect to your usual schedule if possible. The next time it’s easier.</p>
<h3>2. Study the principles of Plain English</h3>
<p>Remember: you want your request for proposal to be understood in one reading. This means you need to:</p>
<ul>
<li>Identify your <a href="http://www.klariti.com/Audience-Analysis-Templates/">target audience</a> i.e. Government departments. </li>
<li>Consider what they need to know. </li>
<li>Consider the technical terms they may, or may not, know. </li>
<li><a href="http://www.plainlanguage.gov/">Develop plain English writing guidelines</a> for your staff. </li>
<li>Think about how to organize and format your Proposal. </li>
</ul>
<h3>3. Promote Plain English amongst your Staff</h3>
<p>Once you’ve seen the benefits of plain English compared with other writing styles, you can promote its values to your own staff and senior management. You need to get your staff onside so that they will begin writing in this style. Likewise, you also need to convince your managers of its values and possibly funding for a training program. Explain to both camps how they will benefit. Outline a high-level roadmap with timelines for the overall program.</p>
<h3>4. Contact an experienced proposal writer</h3>
<p>The first time you write a plain English proposal, you may find it time-consuming and more difficult than you thought. If this is the case, you’re on the right track! Everything worthwhile is difficult the first time round – soon you will get the hang of it.</p>
<p>You can also approach a writing consultant, especially someone who has a proven track record of writing good, clear English.</p>
<h3>5. Review previous Proposals and see where you can improve</h3>
<p>Before you start writing, consider the following: <b></b></p>
<ul>
<li><b>Literacy level. </b>What level of education is required to understand the Proposal? Use the <a href="http://www.klariti.com/business-writing/Fog-Index-Readability-Formulas.shtml">Fog Index to test your proposal’s readability</a>. </li>
<li><b>Clarity. </b>What parts of the Proposal are hard to understand? Are the sentences too long and complex? Does it use technical terms and acronyms that the target audience will not understand? </li>
<li><b>Organization. </b>How easy can you find relevant information? Would the Proposal be clearer if you reordered the main sections and possibly the sub-sections within it? Does the table of contents and index need sharpening? Are there too many/too few levels of information in the TOC. </li>
<li><b>Repetition. </b>Is the same information repeated in several sections? Does it have any real benefit? </li>
<li><b>Headings. </b>Should the headings be re-written in the form of questions that each section answers? </li>
<li><b>Format. </b>Do you need to add more bullet-point lists? Put keywords in bold? Use more white space? </li>
</ul>
<h3>6. Create an outline to help readers find information faster</h3>
<p>One very effective writing style is to <b>write headings as questions,</b>which each section answers. If you include sub-sections, use a numbered outline format (e.g. 1.2, 1.3) for the section headings. This helps the reader find the main sections quickly and see the relationship among subsections.</p>
<h3>7. Write the RFP, section by section, using plain language techniques</h3>
<p>If some sections are hard to write, read them aloud and see where they are difficult to understand. Go through the document section by section.</p>
<p>Write the first draft of key sections first, and then work on the inside sections. Once you’ve written these, refine the text by editing each section tightly. However, make sure your text does not become too cold and dry. Write as if you were speaking to a colleague whom you respect; this often helps control the tone of the document.</p>
<h3>8. Review and Revise</h3>
<p>Once you’ve finished the first draft, get it reviewed internally by colleagues who can add value to the review process. Don’t choose colleagues who are too close to the Proposal, as they will not see errors. Instead, get a neutral reviewer if possible. After getting the feedback, make the required edits.</p>
<p>If possible, ask volunteers from the target population to review the draft Proposal. Ask them if they can locate information easily. When interviewing ask open questions and you will get a better response.</p>
<p>Avoid closed questions, such as, is this a great RFP? Most will say Yes, just to please you – and make you go away!</p>
<p>Ask how much they could read in one sitting. Again, revise as needed.</p>
<h3>9. Create an easy-to-read format</h3>
<p>Format the document to make it easy to read and attractive in presentation. If you have time, prepare a template that can be re-used for all future RFP’s. This will reduce the time spend on preparing the document.</p>
<ul>
<li>Leave a blank line between paragraphs </li>
<li>Use bulleted lists </li>
<li>Highlight main points with <b>bold </b>and <i>italics</i> </li>
<li>Use boxes for examples </li>
<li>Use white space generously </li>
<li>Include margins of at least one inch all around the page </li>
<li>Use two (2) columns to increase readability, if practical </li>
</ul>
<p>Use several different type sizes for headings. In many documents, the headings are in San Serif font (i.e. Verdana) and the body is in a Serif font (e.g. Times New Roman). Use a contrast in style to add emphasis.</p>
<h3>10. Get feedback – and share it</h3>
<p>Lastly, see if the Proposal works! Ask the external reviewers how they felt using the ‘new’ plain English Proposal. Get feedback from personnel involved in the review process and collate it for distribution.</p>
<ul>
<li>Did they find that the plain English Proposal made a better application? </li>
<li>Was it easier to write the application, and what made the most difference? </li>
<li>What worked and what needs more refinement. </li>
</ul>
<p>Summarize what you learned and share this information with colleagues. Encourage them to try writing plain English Proposals.</p>
<h3>Track Your Proposal Wins</h3>
<p>Keep a record of all the Proposals written in plain English and see if their success rate is higher than the previous styles of writing. There are more great writing resources are at: <a title="http://www.plainenglish.co.uk/" href="http://www.plainenglish.co.uk/">http://www.plainenglish.co.uk/</a></p>
<p><i>About the Author: Ivan Walsh provides <a href="http://www.klariti.com/">Business Tips for Smart People</a> on <a href="http://www.klariti.com/">Klariti.com</a>. His also runs the popular <a href="http://www.ivanwalsh.com">Business Planning Blog</a> at </i><a href="http://www.ivanwalsh.com"><i>http://www.ivanwalsh.com</i></a>. Follow him on Twitter <a href="http://twitter.com/ivanwalsh">@ivanwalsh</a></p>
<p>PS: The <a href="http://www.klariti.com/Audience-Analysis-Templates/">Audience Analysis Template</a> is here.</p>


<p>Related posts:<ol><li><a href='http://www.proposalwritingcourse.com/proposal/warren-buffett-on-better-business-writing/' rel='bookmark' title='Permanent Link: What Warren Buffett Taught Me About Writing Executive Summaries'>What Warren Buffett Taught Me About Writing Executive Summaries</a></li>
<li><a href='http://www.proposalwritingcourse.com/proposal-writing/kate-winslets-7-secret-ways-to-revise-technical-documents/' rel='bookmark' title='Permanent Link: Kate Winslet&rsquo;s 7 Smart Ways to Read Business Proposals'>Kate Winslet&rsquo;s 7 Smart Ways to Read Business Proposals</a></li>
<li><a href='http://www.proposalwritingcourse.com/proposal-writing/super-glue-strategic-goals-to-business-development-activities/' rel='bookmark' title='Permanent Link: Four-Step Strategy for Better Business Proposals'>Four-Step Strategy for Better Business Proposals</a></li>
</ol></p>]]></content:encoded>
			<wfw:commentRss>http://www.proposalwritingcourse.com/proposal-writing/using-plain-language-writing-techniques-to-write-better-proposals/feed/</wfw:commentRss>
		<slash:comments>0</slash:comments>
		</item>
		<item>
		<title>What Warren Buffett Taught Me About Writing Executive Summaries</title>
		<link>http://www.proposalwritingcourse.com/proposal/warren-buffett-on-better-business-writing/</link>
		<comments>http://www.proposalwritingcourse.com/proposal/warren-buffett-on-better-business-writing/#comments</comments>
		<pubDate>Tue, 29 Jun 2010 04:02:40 +0000</pubDate>
		<dc:creator>Editor</dc:creator>
				<category><![CDATA[Proposal]]></category>
		<category><![CDATA[Annual Report]]></category>
		<category><![CDATA[Business Plan]]></category>
		<category><![CDATA[Case Study]]></category>
		<category><![CDATA[Executive Summary]]></category>
		<category><![CDATA[Marketing Plan]]></category>
		<category><![CDATA[Style Guide]]></category>

		<guid isPermaLink="false">http://www.proposalwritingcourse.com/proposal/warren-buffett-on-better-business-writing/380/</guid>
		<description><![CDATA[What I like about Warren Buffets Annual Reports is that he says so much with so few words. And loses nothing in the process. For those of us who make a living writing business documents there are a few lessons to be learnt here. Why The Executive Summary is Important The Executive Summary of any [...]


No related posts.]]></description>
			<content:encoded><![CDATA[<p></p><p>What I like about Warren Buffets Annual Reports is that he says so much with so few words. And loses nothing in the process. For those of us who make a living writing business documents there are a few lessons to be learnt here. </p>
<h3>Why The Executive Summary is Important</h3>
<p>The Executive Summary of any business document is the first impression you make on the reader. If your business plan’s executive summary is poorly written, dull, or cut/pasted together it will hardly get noticed and the effort you put into the rest of the document won’t be seen. </p>
<p>Instead, set aside two or three hours and write the best Executive Summary you can. Challenge yourself to write three hundred words that excite you, generate interest, and paint a picture of your company. People want to read about other people. Don’t forget the power of human interest. In the end, they’re going to do business with you – not your product. </p>
<p>‘The business schools reward difficult complex behavior more than simple behavior, but simple behavior is more effective.’ Warren Buffett</p>
<p><a href="http://www.proposalwritingcourse.com/wp-content/uploads/2010/06/warrenbuffet.jpg"><img style="border-right-width: 0px; display: block; float: none; border-top-width: 0px; border-bottom-width: 0px; margin-left: auto; border-left-width: 0px; margin-right: auto" title="headshot of warren buffet" border="0" alt="headshot of warren buffet" src="http://www.proposalwritingcourse.com/wp-content/uploads/2010/06/warrenbuffet_thumb.jpg" width="468" height="306" /></a></p>
<h3>How to Write an Executive Summary that generates interest</h3>
<p>Your Executive Summary should excite the reader and help them understand the key results and conclusions in your business document, whether it’s your business proposal, business plan, annual report, <a href="http://www.klariti.com/case-study/Case-Study-Tips.shtml" target="_blank">case study</a> or <a href="http://www.klariti.com/white-papers/index.shtml" target="_blank">white paper</a>. </p>
<p><em>Looking for inspiration?</em> </p>
<p>Read the <a href="http://www.berkshirehathaway.com/letters/letters.html" target="_blank">Annual Reports written by Warren Buffett</a> and you’ll see how he does it. You know he has confidence in his company. He highlights the goods news in a nice understated way and delivers the less pleasant results with the same even tone. </p>
<h3>Executive Summary Definition</h3>
<p>Here’s one definition from The Handbook of Technical Writing, “An executive summary is to consolidate the principal points of a report in one place. It must cover the information in the report in enough detail to reflect accurately its content but concisely enough to permit an executive to digest the significance of the report without having to read it in full&#8230;.&quot; </p>
<h3>Characteristics of a Well-Written Executive Summary</h3>
<p>While this is a business document in the tradition sense, you must still find ways to stimulate the reader’s interest, make them want to turn the page and take some action.</p>
<ul>
<li>Executive summaries must be original. </li>
<li>Executive summaries must <strong>not be cut-and-pastes extracts</strong> from the main document. </li>
<li>Executive Summary <strong>should provide unique information not contained anywhere else</strong>. </li>
<li>Executive summaries are <strong>standalone documents</strong>. The reader, for example, an investor, should be able to grasp your over-arching aims without having to read the entire document. </li>
</ul>
<h3>Documents That Require Executive Summaries</h3>
<p>Some business documents require summaries, others don’t. Write an executive summary for the following types of documents: </p>
<ul>
<li>Grant Applications </li>
<li>Standards </li>
<li>System Design Documents </li>
<li>Technical Reports </li>
<li>Training Plans </li>
<li>White Papers </li>
</ul>
<h3>Documents That Do Not Require Executive Summaries</h3>
<p>You do NOT need to write an Executive Summary for shorter documents or certain technical publications, such as:</p>
<ul>
<li>Functional Specifications </li>
<li>Meeting minutes </li>
<li>Release Notes </li>
<li>Status Reports </li>
<li>User Manuals </li>
<li>Workshop reports </li>
</ul>
<h3>Executive Summary Format &amp; Guidelines </h3>
<p>These are guidelines for your Executive Summary. They’re not set in stone, so adjust where necessary. The summary should cover the: </p>
<ul>
<li>Purpose </li>
<li>Scope </li>
<li>Methodology </li>
<li>Results </li>
<li>Conclusions </li>
</ul>
<p>In general, you can write it as follows:</p>
<ul>
<li>First paragraph answers: &quot;What is this document about?&quot; </li>
<li>Summary answers &quot;How did you get the information?&quot; </li>
<li>Expand on the Software Development process (if applicable) </li>
<li>Facts </li>
<li>Results </li>
<li>Conclusions </li>
<li>Findings Note: present facts in tabular format. </li>
<li>Recommendations </li>
</ul>
<h3>What doesn’t go in the Executive Summary?</h3>
<p>Other information that doesn’t go in the Executive Summary includes:</p>
<ul>
<li>Acknowledgments </li>
<li>Background data </li>
<li>Cross-references </li>
<li>Footnotes </li>
<li>Industry updates </li>
<li>Justifications </li>
<li>Objectives </li>
<li>Project history </li>
<li>References </li>
</ul>
<p>Remember to close your executive summary will a strong summary statement. This must persuade the reader that your business is a winner and the only way to do this is to turn the page and learn more about your company.</p>
<h3>Final Tips for Writing the Business Plan’s Executive Summary</h3>
<p>Provide a summary. The business plan itself gives the financial details. </p>
<ul>
<li>Use strong and positive language. </li>
<li>No more two pages long. Don’t pad your business plan’s executive summary with fluff. </li>
<li>Generate interest by enticing your reader to read the rest of the business plan, not tell him everything. </li>
<li>Read it aloud. Does it read well or sound artificial? Is it clear and succinct? </li>
<li>Adjust the executive summary for your respective audience. For example, if you want to attract investors, focus on the opportunity your business provides investors and why this opportunity is so special. </li>
<li>Put yourself in your readers’ shoes. Does the executive summary really make you feel excited? If not, why? </li>
</ul>
<p>The final word goes on Warren. Here’s his take on gold, “It gets dug out of the ground in Africa, or someplace. Then we melt it down, dig another hole, bury it again and pay people to stand around guarding it. It has no utility. Anyone watching from Mars would be scratching their head.”</p>
<p>Make sense?</p>
<p><em>About the Author: Ivan Walsh provides <a href="http://www.klariti.com/">Business Tips for Smart People</a> on <a href="http://www.klariti.com/">Klariti.com</a>. His also runs the <a href="http://www.ivanwalsh.com">Business Planning Blog</a> at </em><a href="http://www.ivanwalsh.com"><em>http://www.ivanwalsh.com</em></a></p>
<p><strong>PS</strong>: The <a href="http://www.klariti.com/business-plan-template/index.shtml" target="_blank">Business Plan Template</a> is available from our partner here.</p>


<p>No related posts.</p>]]></content:encoded>
			<wfw:commentRss>http://www.proposalwritingcourse.com/proposal/warren-buffett-on-better-business-writing/feed/</wfw:commentRss>
		<slash:comments>0</slash:comments>
		</item>
		<item>
		<title>Kate Winslet&#8217;s 7 Smart Ways to Read Business Proposals</title>
		<link>http://www.proposalwritingcourse.com/proposal-writing/kate-winslets-7-secret-ways-to-revise-technical-documents/</link>
		<comments>http://www.proposalwritingcourse.com/proposal-writing/kate-winslets-7-secret-ways-to-revise-technical-documents/#comments</comments>
		<pubDate>Thu, 10 Jun 2010 02:15:00 +0000</pubDate>
		<dc:creator>Editor</dc:creator>
				<category><![CDATA[Proposal Writing]]></category>
		<category><![CDATA[Busiess]]></category>
		<category><![CDATA[Editor]]></category>
		<category><![CDATA[Format]]></category>
		<category><![CDATA[Free]]></category>
		<category><![CDATA[Proposal]]></category>
		<category><![CDATA[Revision]]></category>
		<category><![CDATA[Sample]]></category>
		<category><![CDATA[Style Guide]]></category>
		<category><![CDATA[Technical Writer]]></category>

		<guid isPermaLink="false">http://www.proposalwritingcourse.com/proposal-writing/kate-winslets-7-secret-ways-to-revise-technical-documents/353/</guid>
		<description><![CDATA[Post by Ivan Walsh. Follow me on Twitter. What can Kate Winslet teach you about proof-reading Business Proposals? Watch the movie The Reader and it will make sense. If she was writing this blog, she’d probably say: “Don’t do it all at once! One of the biggest mistakes you can make when revising any business [...]


No related posts.]]></description>
			<content:encoded><![CDATA[<p></p><p>Post by <a href="http://www.klariti.com/">Ivan Walsh</a>. Follow me on <a href="http://twitter.com/klaritidotcom">Twitter</a>.</p>
<p>What can Kate Winslet teach you about proof-reading <a href="http://www.proposalwritingcourse.com/proposal-writing/4-smart-ways-to-write-business-proposals-that-win-contracts/346/" target="_blank">Business Proposals</a>? Watch the movie <a href="http://www.amazon.com/gp/product/B001PPLJIQ?ie=UTF8&amp;tag=klaritiwritin-20&amp;linkCode=as2&amp;camp=1789&amp;creative=390957&amp;creativeASIN=B001PPLJIQ">The Reader</a> and it will make sense. If she was writing this blog, she’d probably say: “Don’t do it all at once! One of the biggest mistakes you can make when <a href="http://www.proposalwritingcourse.com/proposal-evaluation/how-to-ensure-your-proposal-gets-accepted-by-difficult-evaluators-2/226/" target="_blank">revising any business proposal</a>, is to do it all in one go. You can’t!” And she’d be right.<span id="more-353"></span></p>
<h3>7 Ways to Check User Guides</h3>
<p><a href="http://www.proposalwritingcourse.com/wp-content/uploads/2010/05/technicalwriterkatewinslet.jpg"><img style="display: block; float: none; margin-left: auto; margin-right: auto; border-width: 0px;" title="technical-writer-kate-winslet" src="http://www.proposalwritingcourse.com/wp-content/uploads/2010/05/technicalwriterkatewinslet_thumb.jpg" border="0" alt="technical-writer-kate-winslet" width="502" height="338" /></a></p>
<p>Make it easy on yourself and focus on one area at a time. Instead of revising the document in one session, break out the tasks and revise the document by task. For example, start with checking the facts, then the spelling, how the document flows, cross-references, footers, index entries and so on.</p>
<p><strong>Seven Ways to Read Business Proposals.</strong></p>
<ol>
<li><strong>Overview</strong> &#8211; In the opening section, do you have a statement, a sentence or two that states the main point or argument of your document? Likewise, is there a conclusion that ties together all the points made in your document?</li>
<li><strong>Tasks</strong> &#8211; Does your user guide address the <a href="http://www.klariti.com/Audience-Analysis-Templates/" target="_blank">user’s requirements</a>? Check the document to see if you addressed each task and provided enough information for the user to perform the task.</li>
<li><strong>Structure</strong> &#8211; Does the document flow? Make sure each topic connects clearly and logically. Do the topic sentences of each paragraph relate to the subject matter?</li>
<li><strong>Accuracy</strong> &#8211; Is the information correct? Is it adequately documented? Have you <a href="http://www.klariti.com/technical-writing/How-Stephen-King-Made-Me-Better-Technical-Writer.shtml">tested the document</a> so that it helps the reader to perform their tasks?</li>
<li><strong>Language</strong> &#8211; Do you use specific language? Avoid vague terms such as in the event of, thing, factors, and over reliance on unclear pronouns like &#8220;this&#8221; and &#8220;it.&#8221;</li>
<li><strong>Drafts</strong> – <a href="http://www.ihearttechnicalwriting.com/technical-writing/my-top-ten-favorite-technical-writing-tools/4441/">Technical Writing involves writing multiple drafts</a>. This means that after each draft, you need to check that the edits have been included in the correct draft.</li>
<li><strong>Read Aloud</strong> – Get into the habit of reading your documents aloud. If you have trouble reading a sentence clearly and smoothly, it probably needs to be rewritten. And if it sounds wrong to your ear, then that’s a warning sign that something needs to be corrected.</li>
</ol>
<p>PS &#8211; I also use a <a href="http://klariti.com/software-development-lifecycle-templates/datasheet-template.shtml">checklist to check off the different tasks</a> as I revise technical document. This is especially helpful if you’re working late or are revising several documents in succession.</p>
<p>One mistake to avoid is to focus on one area, for example spelling, and overlook other areas, for example, the accuracy of the material. While the reader may forgive you for the occasional spelling mistake, they won&#8217;t be impressed if the material itself is incorrect.</p>
<p>How do you revise your documents? What mistakes do you see most often?</p>
<p><strong><em>About the Author:</em></strong><em> Ivan Walsh is a 40-something technical writer with a weakness for <a href="http://www.klariti.com/documentation-plan-template/">documentation plan guides</a>. His other obsession is <a href="http://www.videocameraschool.com/" target="_blank">video marketing</a> at <a href="http://www.videocameraschool.com/">http://www.videocameraschool.com/</a></em></p>


<p>No related posts.</p>]]></content:encoded>
			<wfw:commentRss>http://www.proposalwritingcourse.com/proposal-writing/kate-winslets-7-secret-ways-to-revise-technical-documents/feed/</wfw:commentRss>
		<slash:comments>0</slash:comments>
		</item>
	</channel>
</rss>

