I Heart Technical Writing header image 4

Entries from July 15th, 2008

Difference between a Case Study and a White Paper

July 15th, 2008 · Comments Off · Communications, Social Media, Technical Writing

 
Can tell me the difference between a case study and a white paper. I read your case study overview and am having a hard time differentiating between them. If you have a minute, can you clarify?

[Read more →]

Tags: ···

How to agree on a Statement of Work

July 15th, 2008 · Comments Off · Communications, Social Media, Technical Writing

Question: I have an short term contract to develop Standard Operating Procedures but the statement of work is very light.  Any suggestion on questions to ask in kick off meeting to assure preparing best documentation for client?

[Read more →]

Tags: ···

Table of Contents doesn’t work in Word

July 15th, 2008 · Comments Off · Communications, Social Media, Technical Writing

Here’s a common problem with MS Word. 
For some unknown reason, the Table of Contents (which was there this morning) is now gone.
When you look at the page in Word, you might see this error message:
{ TOC\O "2-4"\H \Z \T "HEADING 1,1"}
What’s going on?

[Read more →]

Tags: ···

Using Microsoft Word to Create Large Documents – Lesson 1

July 15th, 2008 · Comments Off · Communications, Social Media, Technical Writing

I’m often asked for tips on how to write large documents in Microsoft Word?
From what I have see, the main issues with creating long docs in Word tend to involve formatting, styles, graphics, tables, and bullets.
Formatting — cutting/pasting material directly from one file into another is best avoided as this will bring unwanted [...]

[Read more →]

Tags: ···

Creating Content for Mobile Devices

July 15th, 2008 · Comments Off · Communications, Social Media, Technical Writing

IDC (International Data Corporation) recently estimated the total number of all handheld devices shipped worldwide will exceed 24.8 million this year.
By combining software and design principles, companies are planning to extend their enterprise and Web-based applications to handheld computers on the Palm, Psion and Windows CE platforms.
These devices are designed for mobility. Therefore [...]

[Read more →]

Tags: ···

10 Steps For High Impact Proposals

July 15th, 2008 · Comments Off · Communications, Social Media, Technical Writing

This guide is designed to help you write a Request For Proposals (RFP) in clear English.
Its objective is to help you write and format an RFP that your target audience can understand in one reading. Use Plain language techniques to help you win business, accelerate your tender process, and encourage staff to contribute to the [...]

[Read more →]

Tags: ···

Using the WRONG tone in your emails

July 15th, 2008 · Comments · Communications, Social Media, Technical Writing

When writing emails, what you actually write and what you mean to say can come across as quite different.
“But what I meant was…” Too late! The damage has been done.
The impact of the words you use will have a different effect depending on how you phrase them, for example, short email headings can appear [...]

[Read more →]

Tags: ···

How to Write Web Content

July 15th, 2008 · Comments Off · Communications, Social Media, Technical Writing

This article explains how to write content and how to tailor content to online audiences.
The primary differences between web-based text content and printed media are related to:

Hypertext — users have the ability to jump to another page with one click
Points of Entry — users frequently enter article at mid-point after finding it in [...]

[Read more →]

Tags: ···

How to Evaluate Your Competitor’s Web site

July 15th, 2008 · Comments Off · Communications, Social Media, Technical Writing

Use this list to evaluate your competitor’s websites so you can create a site that gives you the edge over them.

Brand — does the site add or detract from the companies brand equity?
Content — does the quality of the content captive your attention?
Goals — are the goals and objectives of your competitor’s [...]

[Read more →]

Tags: ···

How to Improve Webpage Content

July 15th, 2008 · Comments Off · Communications, Social Media, Technical Writing

Design for Standard Screen Resolutions Most users have their settings set to 600×800 pixels. If you design your site for screen resolutions wider than this remember to accommodate those who will not see the off-screen data.
Users get tired when surfing and will not click around a cramped design looking for [...]

[Read more →]

Tags: ···