Studio Blog

Welcome to the Demand Studios Blog – a resource for writers, contributors and freelancers alike! Come here for answers to your questions, Studio news, writing tips and more.
Approaching Technical How to Articles
Hi all -

There has been a lot of confusion about how to structure How to articles that have multiple solutions, particularly computer and technical How to titles. In an effort to clear this up, we have expanded upon our policy of not including brands and products by adding the following bullet point under Section III, “Demand Studios’ Voice,” of both the Demand Studios Editorial Guidelines and the DS Copy Editor Guidelines.

•    Avoid including brands or products in your article unless the title specifically calls for it. Articles with generic titles, such as technical, computer-based How tos like “How to Build a Website,” should not include instructions on how to complete the task using one specific product. Instead, it should include multiple options with a corresponding explanation in each step.
 
Note that this policy is not new—our guidelines have always prohibited writers from endorsing specific products or brands unless the title specifically called for it. However, lately we have noticed some violations of the policy, especially with computer-related How to titles. For example, take the title “How to Build a Website.” This article could be completed using any number of different programs designed to help a person build a personal website. Some writers are picking one program and instructing the reader to complete the task using that specific product or brand. Aside from endorsing a single type of software or website, the articles that describe one type of software often end up with a lot of obvious walkthrough instructions. Remember, the title is “How to Build a Website,” not “How to Use Software X.”

Alternatively, writers should use one of three options to complete these types of titles:

1.    Our first preference is to tell our readers how to perform the task with tools they already have, rather than downloading or purchasing a third-party tool (even if it is more powerful and makes the task easier). So, whenever possible, use the steps to detail how to accomplish the task with tools “native” to Windows (or Linux or Mac or the operating system in question). For the title “How to Remove Software That Won't Uninstall,” the article might tell the reader to click “Run” in a Start Menu and type “regedit” into the “Open” field. Then the steps would walk us through the process.
2.    The second option is to use each step to offer a different site or software program as a solution. Don’t include navigation instructions as the “solution.” Instead, each step should summarize how the site or software works. So, for example, each step for “Learning English Online” should suggest a different option for fulfilling the task and may summarize how it works—as opposed to including instructions about how to use one website that teaches English.
3.    The final option is to create a separate section for each site or software tool and review the important steps for using that program. You must detail three options in three separate sections.

A single site or software product is acceptable only if no other options exist.

We have included this post in the Training Camp section of both the Writer and Copy Editor Resource Center for you to reference when needed. If writers have questions on how to execute a specific title, please post your question in the Title Clarification forum. If copy editors have questions on how to edit a specific article, please contact your CE lead.

Thanks

25 Comments

User Image

Chanel_A
Feb 1, 6:10 PM

This helps me a lot with an article I wrote about. There was many different options for downloading pictures to a phone, but it made my article confusing. Now I know how to use it!

User Image

GlassGirl
Feb 2, 8:47 AM

I'm confused about #2 where it says, "The second option is to use each step to offer a different site or software program as a solution." How would this be a how-to article if the we just list a summary of each option in the steps? I thought the idea was to enable the reader to actually complete the task with the instruction we provide. Wouldn't strategy #2 be more like a List format? Thank you.

User Image

LizB
Mar 3, 6:08 PM

Thank you for this. I send this link to writers in feedback all day long. It helps them understand why I am asking for a rewrite. It would also be helpful to reiterate that in technical articles we assume Windows unless the title states Mac, and we assume the current version of Windows and applications. That means articles should be about Windows 7, not Vista or XP. And the best place to get how-to information about Windows 7 is directly from Microsoft.

User Image

New Candy
Mar 13, 7:05 PM

Hey, GlassGirl. Did anyone ever address your question? My first thought about #2 was the same as yours ... it would be a List. I'll wait a bit to see if someone can clear this up for us. (We can't be the only ones who think this way ... can we?!!)

User Image

johngugie
Mar 14, 7:17 PM

I don't really understand what liz means by "we assume the current version of Windows and applications. That means articles should be about Windows 7, not Vista or XP." Most people do not have Windows 7 yet and many people have either Vista or XP. We should not assume the most current version of software, such as Windows 7, because consumers are at all different levels of software, some update, some do not. It is safe to assume that most consumers have OS at the XP or higher level. As long as the article states which OS is being used, it should be fine. Also, I think that OS software is a totally separate category from other programs because OS encompasses almost the whole computer in the way it runs other programs. Nothing should be assumed with computers because there is so many different setups.

User Image

PatZ
Mar 24, 4:58 PM

I too send writers to this article often. A question came up in my latest review--I've edited a number of articles about things you can't do with native tools, but there are software apps or online sites that all work pretty much the same way, so if you had a section for each of three options, they'd be almost exactly the same. Writers have pointed this out to me, and so I believe it should be OK to have a single section that applies to three different products that all work the same way, as long as they are all listed in Resources. I'd like confirmation of this.

User Image

TammyM
Apr 5, 2:48 PM

I apologize, but I'm baffled by this. If I'm writing a How-To "tutorial", a reader expects to be lead step-by-step through the creation process. Option 2 does seem to be a List (without specific steps and processes). I would think a reader looking at a title with "tutorial" in the name would in fact be interested in the navigation process. I'd really appreciate a bit more information about this. Thanks!

User Image

DanielC
Apr 30, 5:33 PM

This post is a lot of help to me, who prefers writing the computer how-to's. I would like to say, though, that while I would never tell a reader to purchase any software unless it was the only option available, it would be much easier for them to complete a task if I direct them through the process step-by-step by using a single piece of freeware, preferably open source. Point number 2 would leave me feeling like I never wrote a how-to, while point number 3 could potentially lead to suggesting sub-par software. Also, point 3 could lead to a very, very long article, depending on the complexity of the task.

User Image

JohnD
May 5, 9:51 AM

I feel as though writing multiple options for a single how-to would leave the reader at their own wits to complete the task that they required help.

User Image

Doctor-3D
May 5, 12:11 PM

I feel it is necessary in many how-to tech articles to at least provide some general programs or applications necessary to complete a task. If I am writing an article about how to create your own graphics for a website. Both you and the reader need to have the same tool or tools as a reference. Generalizing all of the different settings, only compounds the initial confusing the reader had before even selecting to read your article. The best way to guide someone is through hands-on learning, but your article needs to be there to serve as a guide so they can follow your steps inside of the same program you used.

Now, it hurt to suggest and let the reader know about other similar programs that are available. Or to even briefly include some steps you would take in those other programs. But, sticking to one general program related to the issue and providing steps and guidelines using that program as a general rule is the most effective method in making your article actually work for the reader.

There is a fine line in making your article sound like an ad or a promotion for just one particular product and just selecting a common, popular, easy to use product that's vastly available as your core program to use as a guideline. I've always thought that so long as you don't boast about the product, and ensure you make the reader aware of alternatives that you would ok. I'm glad I've read this, I will certainly have to change my motives and a lot of my drafts. :(
 1 2 3 >> Last