Posts Tagged ‘ writing for the web ’

Narcotic addict documentation is all too again written by programmers with a view programmers. It tends to distinct on the product’s features, rather than the drug’s tasks. In a general way, programmers aren’t in the ideal bent to be literature purchaser documentation. They’re too close to the bits and bytes, and they’re too near from the user. To them, what the artefact can do tends to be far more important than what the purchaser can do with the product.

It’s a subtle – but compulsory – distinction. Examine shows that the mood to noticeable buyer documentation is editorial struggle oriented help. Unvaried gamester, play down your escape according to the minimalist theory. In the documentation men, “minimalism” is a fancy in a few words to save a commonsense practice technical writing services. In underlying terms, it means eradicate to your reader and repress it simple.

The theory itself has a lot of twists and turns. If you want to announce a vast – but lose long-winded – book on the taxpayer, verify visible the tome “Minimalism Beyond the Nurnberg Funnel”, 1998, edited by John Carroll.

In the meantime, if you can tick every item in the following checklist, you’ll be source on your motion to usable online alleviate that both your readers and your managers will thank you for.

Practical Remedy Checklist

1. Base the inform appropriate on authentic tasks (or realistic examples)

2. Framework the keep from based on recriminate arrangement – Chapter headings should be goals and topics should be tasks

3. Respect the reader’s vim – this is typically more about what you don’t do than what you do. Don’t waste the reader’s measure by diving high into tangents

4. Make capital out of prior knowledge and episode – Lug the reader’s notice to previous tasks, experiences, successes, and failures

5. Thwart mistakes - “Certify you do x in the presence of doing y”

6. Detect and recognize mistakes - “If this fails, you may comprise entered the path incorrectly”

7. Determine mistakes - “Re-enter the circuit”

8. Require gaffe info at intention of tasks where important (guide of thumb, identical inaccuracy info note per three tasks is a well-behaved typical)

9. Don’t break up instructions with notes, cautions, warnings, and anomalous cases - List these things at the tip of the instruction, wherever reachable

10. Be transient, don’t spell everything for all to see, singularly things that can be bewitched owing granted

11. Neglect conceptual and note low-down where workable, or tie to it. Perhaps contribute swelling tidings at the cessation of the point, additional peradventure a note that there are other ways to appear as the task/goal, but this is the easiest

12. Sections should look exclusive of and read hot pants

13. Stipulate closure after sections (e.g., move backwards withdraw from to prototypical screen/goal)

14. Victual an proximate moment to act and encourage research and novelty (abuse physical invitations to edict, such as, “Consort with owing yourself…” or “Prove this…” choose than idle invitations such as, “You can…”)

15. Get users started despatch

16. Permit for reading in any order - for each apportion modular, especially goals, but as the case may be tasks (unquestionably if they can be performed in different purchase order)

17. Highlight things that are not regular

18. Interest active expression to a certain extent than idle agent

19. Try out to account in search the operator’s conditions in your editorial

20. In the forefront column anything, ask yourself “Desire this help my reader?”

By building these practices into your documentation system, you’ll find that your online facilitate becomes easier to write, shorter, and away more usable quest of your reader. What’s more, your boss will love you!

Friday, June 5th, 2009

If your dream is to get published, the chance is before you.The web has opened the portals of opportunity to all aspiring writers and freelance writers .

It’s a whole new world with unlimited access to ideas and subjects for writers. Endless resources and information are available at the click of your mouse to help you get started and keep you going.

It’s up to you to exercise due diligence to make your dream of writing a reality. It does not happen overnight. It all starts with that first, small step towards pursuing your dream. The internet offers all kinds of avenues for anyone who has ambitions to write. Where do you begin?

Read what the multitude of e-zines and newsletters have to offer. This gives you an idea of what interests people as they spend more and more time surfing the web. What are the latest trends ? Pay attention to issues that tend to pop out here and there, again and again.

Subscribe to pertinent groups or forums that can be helpful in your quest. Stay abreast with the latest news, be interested in anything and everything.

Open up your mind. Then, you can decide which venue is right for you. Ask yourself, are you interested in mainstream type of writing ? Or would you choose specific areas of interest?

Assess your inclinations, your passions and your hobbies.What beliefs do you hold close to your heart? Make a list. In your career, what is your area of expertise? Do you write reports ? Do you keep a journal? A diary? You’re

already a writer!

Get excited about writing down your ideas. The golden opportunity is before you, as never before. Actually, jumping in the bandwagon of writing for the internet can be overwhelming for the faint of heart, confusing for the skeptic, yet exciting for the go-getter. Which one are you?

The internet is open to all segments of society and to people from all walks of life. Access is not limited to the technologically inclined. It is no longer as intimidating as it was when the information superhighway first opened in the 20th century. People are less apt to admit their computer illiteracy, rather, more members of our society are learning how to navigate the cyberspace.

Learn about the basic rules of writing for the web. Cyber readers tend to be fast thinkers, speed readers, with only seconds to spare. If you want to grab their attention, remember, you only have precious few seconds to do it.

Take heart. You already know this. You love to see your by-line. The web will help you get your name out there. The more you write, the better you’ll get at it. Technically, if your work gets published on-line, you are considered published.

Only thing, writing for the web for the countless e-zines and newsletters and web-sites is not for those who intend to make a living from their writing. Not at the start.

If you are willing to write and submit your articles for free, don’t miss out. For the aspiring writer, it is a good way to start. The more you write, the more exposure you will get, readers will get to know your name. Writing for the internet helps to drive traffic to your website.

What are you waiting for?

Friday, June 5th, 2009

If your dream is to get published, the chance is before you.The web has opened the portals of opportunity to all aspiring writers and freelance writers .

It’s a whole new world with unlimited access to ideas and subjects for writers. Endless resources and information are available at the click of your mouse to help you get started and keep you going.

It’s up to you to exercise due diligence to make your dream of writing a reality. It does not happen overnight. It all starts with that first, small step towards pursuing your dream. The internet offers all kinds of avenues for anyone who has ambitions to write. Where do you begin?

Read what the multitude of e-zines and newsletters have to offer. This gives you an idea of what interests people as they spend more and more time surfing the web. What are the latest trends ? Pay attention to issues that tend to pop out here and there, again and again.

Subscribe to pertinent groups or forums that can be helpful in your quest. Stay abreast with the latest news, be interested in anything and everything.

Open up your mind. Then, you can decide which venue is right for you. Ask yourself, are you interested in mainstream type of writing ? Or would you choose specific areas of interest?

Assess your inclinations, your passions and your hobbies.What beliefs do you hold close to your heart? Make a list. In your career, what is your area of expertise? Do you write reports ? Do you keep a journal? A diary? You’re

already a writer!

Get excited about writing down your ideas. The golden opportunity is before you, as never before. Actually, jumping in the bandwagon of writing for the internet can be overwhelming for the faint of heart, confusing for the skeptic, yet exciting for the go-getter. Which one are you?

The internet is open to all segments of society and to people from all walks of life. Access is not limited to the technologically inclined. It is no longer as intimidating as it was when the information superhighway first opened in the 20th century. People are less apt to admit their computer illiteracy, rather, more members of our society are learning how to navigate the cyberspace.

Learn about the basic rules of writing for the web. Cyber readers tend to be fast thinkers, speed readers, with only seconds to spare. If you want to grab their attention, remember, you only have precious few seconds to do it.

Take heart. You already know this. You love to see your by-line. The web will help you get your name out there. The more you write, the better you’ll get at it. Technically, if your work gets published on-line, you are considered published.

Only thing, writing for the web for the countless e-zines and newsletters and web-sites is not for those who intend to make a living from their writing. Not at the start.

If you are willing to write and submit your articles for free, don’t miss out. For the aspiring writer, it is a good way to start. The more you write, the more exposure you will get, readers will get to know your name. Writing for the internet helps to drive traffic to your website.

What are you waiting for?

Writing articles for the web is a learned skill. And you can learn it. In fact, you can master it. Once a professional writer in the print publishing world, I had feature articles published by some well-known names (Woman’s Day, The Washington Post, Family Circle, Christian Science Monitor and more). Fortunately, as a self-publisher online, I’m able to transfer some of my professional print writing skills to this form of online publishing. I don’t struggle with writing articles. And that makes filling my websites with useful, well-written information a lot easier for me. But it’s not so for everyone. Some people struggle with article writing. Maybe that’s you.

Do you struggle with writing articles for your website readers? Do you want to write articles for other newsletters and websites that get free website traffic for you, or just more traffic to your website? If you struggle with article writing or if people don’t read your articles, I may be able to help you. While writing content for the web and writing content for print publications is not exactly the same, there is some overlap. Here are some things I’ve learned about both content formats that might help you write better articles for both web publishers and for your websites.

Your article should have:

ORIGINAL CONTENT - The one word magazine writers hate to hear their editor say is “fresh”. Editors frequently use the word as a reason to reject submissions as in “your tips are just not fresh enough”. Editors want originality. Their publishers want originality. Readers want originality. Everyone is in agreement about wanting original article content.

But if something has been said or written about a thousand times before, you CAN still say it again. You just need to have your own original spin and be using your own words (that means no plagiarism too). You need to have your own writing style or personality (which you’ll develop with time). My research tells me that originality is what both readers AND search engines want from online content. They want original content. The articles at your website need to be “fresh”. The articles you submit to publishers need to be “fresh”. With practice and persistence and a little bit of diligence thrown in you CAN write original articles for the web or for your website (to add diversity to all those reprint articles collecting on your site).

CATCHY TITLE - The online experts say you need key words in your online article titles or headlines to catch the attention of the search engines in the right way. That means you need to put the term or phrase you think people are searching for on your subject near the front of your article title (or at least somewhere in it). But you also have to remember that you’re still writing for readers. So on top of making your article title work for search engine optimization, it still has to entice viewers to read it.

You don’t necessarily need a clever article title, just one that appeals to your target audience and briefly describes the article topic. If I’m looking to lose weight quickly you can be certain “Weight Loss - 3 Easy Steps to Lose 10 Pounds in 10 Days at Home” will catch my attention. If I want to know what Britney Spears is doing (and by the way, I don’t), a title like “Guess What Britney Spears Did Now” will catch my attention and make me read further. But if I’m trying to learn the difference between a flat panel monitor and a flat screen, I’m perfectly happy reading an article with a boring title such as “Flat Panel Monitors and Flat Screens Defined for the Home User”. That title addresses my need at the time for specific information I’m seeking on the web. And it has your key phrase “flat panel monitors” right in front too.

GREAT LEAD - The best title in the world won’t keep readers engrossed in your article, if the first paragraph stinks. In the print world, editors happily rewrite their writers’ leading paragraphs to make the lead just so. There are MANY ways to write a leading paragraph. Just remember that your goal is to intrigue the reader while giving him a clear indication of what he’s about to learn in your article. And the SEO experts say the first sentence, or near the beginning of your first paragraph, is a good place to put that key word or phrase once that you’re focusing on for the search engines’ sake.

GOOD GRAMMAR AND SPELLING - Sloppy writing affects your credibility and makes you look lazy. And it makes for a bad reader experience. If you want to keep readers coming back to your website for the content (or publishers coming back to article directories to use your content), get a grasp on your spelling and grammar. A dictionary and grammar book by your side while proofreading your article will be helpful.

CONCISE FLOW - In high school, many students fluffed up their articles with extra words when the teacher assigned them the task of writing a certain word count. That trick isn’t useful after high school (if you ever considered it useful). Most likely you have plenty to say about your topic if you know it well or if you’ve researched it well. Tight concise writing is as appreciated in the online world as it is in the print publishing arena. Don’t repeat yourself or use excessive words to make a point or statement. That will help keep your copy clean. And know that concise writing doesn’t necessarily mean short articles. You don’t have to write 300 word articles. You don’t have to write 3,000 word articles. Just don’t write a 1,200 word article that really can be written in 500 words.

It’s these writing techniques that make you a professional writer and not a sloppy amateur whose writing for the web doesn’t get read. And it’s these techniques that will help you to add better content to your website and get your articles published by other websites and newsletters. And good article writing means more traffic for your website.

Writing articles for the web is a learned skill. And you can learn it. In fact, you can master it. Once a professional writer in the print publishing world, I had feature articles published by some well-known names (Woman’s Day, The Washington Post, Family Circle, Christian Science Monitor and more). Fortunately, as a self-publisher online, I’m able to transfer some of my professional print writing skills to this form of online publishing. I don’t struggle with writing articles. And that makes filling my websites with useful, well-written information a lot easier for me. But it’s not so for everyone. Some people struggle with article writing. Maybe that’s you.

Do you struggle with writing articles for your website readers? Do you want to write articles for other newsletters and websites that get free website traffic for you, or just more traffic to your website? If you struggle with article writing or if people don’t read your articles, I may be able to help you. While writing content for the web and writing content for print publications is not exactly the same, there is some overlap. Here are some things I’ve learned about both content formats that might help you write better articles for both web publishers and for your websites.

Your article should have:

ORIGINAL CONTENT - The one word magazine writers hate to hear their editor say is “fresh”. Editors frequently use the word as a reason to reject submissions as in “your tips are just not fresh enough”. Editors want originality. Their publishers want originality. Readers want originality. Everyone is in agreement about wanting original article content.

But if something has been said or written about a thousand times before, you CAN still say it again. You just need to have your own original spin and be using your own words (that means no plagiarism too). You need to have your own writing style or personality (which you’ll develop with time). My research tells me that originality is what both readers AND search engines want from online content. They want original content. The articles at your website need to be “fresh”. The articles you submit to publishers need to be “fresh”. With practice and persistence and a little bit of diligence thrown in you CAN write original articles for the web or for your website (to add diversity to all those reprint articles collecting on your site).

CATCHY TITLE - The online experts say you need key words in your online article titles or headlines to catch the attention of the search engines in the right way. That means you need to put the term or phrase you think people are searching for on your subject near the front of your article title (or at least somewhere in it). But you also have to remember that you’re still writing for readers. So on top of making your article title work for search engine optimization, it still has to entice viewers to read it.

You don’t necessarily need a clever article title, just one that appeals to your target audience and briefly describes the article topic. If I’m looking to lose weight quickly you can be certain “Weight Loss - 3 Easy Steps to Lose 10 Pounds in 10 Days at Home” will catch my attention. If I want to know what Britney Spears is doing (and by the way, I don’t), a title like “Guess What Britney Spears Did Now” will catch my attention and make me read further. But if I’m trying to learn the difference between a flat panel monitor and a flat screen, I’m perfectly happy reading an article with a boring title such as “Flat Panel Monitors and Flat Screens Defined for the Home User”. That title addresses my need at the time for specific information I’m seeking on the web. And it has your key phrase “flat panel monitors” right in front too.

GREAT LEAD - The best title in the world won’t keep readers engrossed in your article, if the first paragraph stinks. In the print world, editors happily rewrite their writers’ leading paragraphs to make the lead just so. There are MANY ways to write a leading paragraph. Just remember that your goal is to intrigue the reader while giving him a clear indication of what he’s about to learn in your article. And the SEO experts say the first sentence, or near the beginning of your first paragraph, is a good place to put that key word or phrase once that you’re focusing on for the search engines’ sake.

GOOD GRAMMAR AND SPELLING - Sloppy writing affects your credibility and makes you look lazy. And it makes for a bad reader experience. If you want to keep readers coming back to your website for the content (or publishers coming back to article directories to use your content), get a grasp on your spelling and grammar. A dictionary and grammar book by your side while proofreading your article will be helpful.

CONCISE FLOW - In high school, many students fluffed up their articles with extra words when the teacher assigned them the task of writing a certain word count. That trick isn’t useful after high school (if you ever considered it useful). Most likely you have plenty to say about your topic if you know it well or if you’ve researched it well. Tight concise writing is as appreciated in the online world as it is in the print publishing arena. Don’t repeat yourself or use excessive words to make a point or statement. That will help keep your copy clean. And know that concise writing doesn’t necessarily mean short articles. You don’t have to write 300 word articles. You don’t have to write 3,000 word articles. Just don’t write a 1,200 word article that really can be written in 500 words.

It’s these writing techniques that make you a professional writer and not a sloppy amateur whose writing for the web doesn’t get read. And it’s these techniques that will help you to add better content to your website and get your articles published by other websites and newsletters. And good article writing means more traffic for your website.

Thursday, February 12th, 2009

User documentation is all too often written by programmers for programmers. It tends to focus on the product’s features, rather than the user’s tasks. Generally, programmers aren’t in the ideal position to be writing user documentation. They’re too close to the bits and bytes, and they’re too far from the user. To them, what the product can do tends to be far more important than what the user can do with the product.

It’s a subtle &ndash but vital &ndash distinction. Research shows that the key to effective user documentation is writing task oriented help. Even better, write your help according to the minimalist theory. In the documentation world, “minimalism” is a fancy word for a commonsense practice. In basic terms, it means write to your reader and keep it simple.

The theory itself has a lot of twists and turns. If you want to read a great &ndash but slightly wordy &ndash book on the subject, check out the book “Minimalism Beyond the Nurnberg Funnel”, 1998, edited by John Carroll.

In the meantime, if you can tick every item in the following checklist, you’ll be well on your way to usable online help that both your readers and your managers will thank you for.

Helpful Help Checklist

1. Base the help on real tasks (or realistic examples)

2. Structure the help based on task sequence &ndash Chapter headings should be goals and topics should be tasks

3. Respect the reader’s activity &ndash this is generally more about what you don’t do than what you do. Don’t waste the reader’s time by diving off into tangents

4. Exploit prior knowledge and experience &ndash Draw the reader’s attention to previous tasks, experiences, successes, and failures

5. Prevent mistakes - “Ensure you do x before doing y”

6. Detect and identify mistakes - “If this fails, you may have entered the path incorrectly”

7. Fix mistakes - “Re-enter the path”

8. Provide error info at end of tasks where necessary (rule of thumb, one error info note per three tasks is a good average)

9. Don’t break up instructions with notes, cautions, warnings, and exceptional cases - Put these things at the end of the instruction, wherever possible

10. Be brief, don’t spell everything out, especially things that can be taken for granted

11. Omit conceptual and note information where possible, or link to it. Perhaps provide expansion information at the end of the topic, plus maybe a note that there are other ways to perform the task/goal, but this is the easiest

12. Sections should look short and read short

13. Provide closure for sections (e.g., back to original screen/goal)

14. Provide an immediate opportunity to act and encourage exploration and innovation (use active invitations to act, such as, “See for yourself…” or “Try this…” rather than passive invitations such as, “You can…”)

15. Get users started quickly

16. Allow for reading in any order - make each section modular, especially goals, but perhaps tasks (definitely if they can be performed in different order)

17. Highlight things that are not typical

18. Use active voice rather than passive voice

19. Try to account for the user’s environment in your writing

20. Before writing anything, ask yourself “Will this help my reader?”

By building these practices into your documentation process, you’ll find that your online help becomes easier to write, shorter, and far more usable for your reader. What’s more, your boss will love you!

Tuesday, January 27th, 2009

User documentation is all too often written by programmers for programmers. It tends to focus on the product’s features, rather than the user’s tasks. Generally, programmers aren’t in the ideal position to be writing user documentation. They’re too close to the bits and bytes, and they’re too far from the user. To them, what the product can do tends to be far more important than what the user can do with the product.

It’s a subtle &ndash but vital &ndash distinction. Research shows that the key to effective user documentation is writing task oriented help. Even better, write your help according to the minimalist theory. In the documentation world, “minimalism” is a fancy word for a commonsense practice. In basic terms, it means write to your reader and keep it simple.

The theory itself has a lot of twists and turns. If you want to read a great &ndash but slightly wordy &ndash book on the subject, check out the book “Minimalism Beyond the Nurnberg Funnel”, 1998, edited by John Carroll.

In the meantime, if you can tick every item in the following checklist, you’ll be well on your way to usable online help that both your readers and your managers will thank you for.

Helpful Help Checklist

1. Base the help on real tasks (or realistic examples)

2. Structure the help based on task sequence &ndash Chapter headings should be goals and topics should be tasks

3. Respect the reader’s activity &ndash this is generally more about what you don’t do than what you do. Don’t waste the reader’s time by diving off into tangents

4. Exploit prior knowledge and experience &ndash Draw the reader’s attention to previous tasks, experiences, successes, and failures

5. Prevent mistakes - “Ensure you do x before doing y”

6. Detect and identify mistakes - “If this fails, you may have entered the path incorrectly”

7. Fix mistakes - “Re-enter the path”

8. Provide error info at end of tasks where necessary (rule of thumb, one error info note per three tasks is a good average)

9. Don’t break up instructions with notes, cautions, warnings, and exceptional cases - Put these things at the end of the instruction, wherever possible

10. Be brief, don’t spell everything out, especially things that can be taken for granted

11. Omit conceptual and note information where possible, or link to it. Perhaps provide expansion information at the end of the topic, plus maybe a note that there are other ways to perform the task/goal, but this is the easiest

12. Sections should look short and read short

13. Provide closure for sections (e.g., back to original screen/goal)

14. Provide an immediate opportunity to act and encourage exploration and innovation (use active invitations to act, such as, “See for yourself…” or “Try this…” rather than passive invitations such as, “You can…”)

15. Get users started quickly

16. Allow for reading in any order - make each section modular, especially goals, but perhaps tasks (definitely if they can be performed in different order)

17. Highlight things that are not typical

18. Use active voice rather than passive voice

19. Try to account for the user’s environment in your writing

20. Before writing anything, ask yourself “Will this help my reader?”

By building these practices into your documentation process, you’ll find that your online help becomes easier to write, shorter, and far more usable for your reader. What’s more, your boss will love you!