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

26 Comments

User Image

DavidF
May 9, 2:32 PM

"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."

Fascinating switch from third person plural to second person singular. Very graceful.

User Image

KenrickC
May 10, 4:19 AM

I just got a rewrite for my article and they cited this blog post as the basis for their request. However, upon seeing that a lot of people are just as confused as I am, I would like to know the final decision on Point 2 and the other excellent questions posted in response to Jennifer M. If I had to guess, I would say that the CEs see this as a very cut and dry issue while the questions are coming from writers.

It is not only impossible, but counterproductive to try to generalize a technical article that involves using computers. While it is easy to avoid saying "Stihl chainsaw" and say "use chainsaw to cut down the tree," a computer based task requires software and software requires an explanation on how to use it. I can understand avoiding the use of paid software, but if we use freeware and open source there should be no restrictions whatsoever.

Any DS staff reading this, please take the time to address the comments and questions posted. Without proper clarification, the writers will continue to write the same way.

User Image

PeterFl
May 11, 7:14 AM

Thank you for this. I have a more particular question. I am a statistician, and have started writing some DS articles on statistics. These tasks simply cannot be done without software - and no adequate software is native to Windows. Should all these titles be rewritten to call for a specific software? Thank you

User Image

MitchellC
May 12, 7:06 PM

Another thing I feel I need more clarification on is the issue of people using different operating systems. If an article is asking me "How to convert X to X", how should I approach the issue of people using different OS's, thus significantly transforming the process?

For instance, a Mac OS may have a native tool to complete the task, while a Windows machine may require something being downloaded.

How do I arrange this in steps?

"Step 1: If you are using a Mac... If you are not using a Mac... skip to Step 2."

Something like that? I've tried this whole "Skip step X" thing before, and usually got some grief from the CE's.

User Image

Charles Poole
May 19, 10:08 AM

From #1. Why would we not send the reader to a piece of shareware that would do the task in one click other than sending them on a barrage of steps to complete the task? If I'm the reader, wouldn't I want to be able to do the task in the least amount of time possible? And if one software program does the same task as forty other applications, but does it better, why would we even include other programs for that task? If the reader is who we care about then we should be focusing on getting them the best program possible so they can complete their task in the least amount of time possible.

User Image

MeghanP
Jun 10, 8:39 AM

Well, what I don't get is the editorial comments. First you guys tell me that I'm using too many words (sentence giving too much detail,) and then you tell me its too short and I have choppy sentences. I don't get what I should do. When I write a tutorial, I tell the readers what to do, where to go, and how to do it. No one likes to read a tutorial and be browing around trying to find the button I tell them to click or trying to find the microscopic text that's displayed at the very bottom. It just seems that you guys want to have your cake and eat it to. I hope someone can please explain to me further how I can tell readers how to remove an Antivirus without Malwarebytes. The truth of the matter is if I suggest deleting files, and they delete the wrong one, who is going to get blamed? Not them.

User Image

Tommy C
Jun 18, 4:06 PM

I agree with Glass Girl. Option number two takes it beyond the realm of a proper how-to. A list of possible solutions with vague solutions will not satisfy the user who is searching for a concrete solution.


















User Image

Alvaro Roque
Jun 24, 3:17 PM

These are great tips. I was never too sure how to appropriately complete these articles. Thank you so much.
A

User Image

DustinT
Jun 26, 3:10 PM

Does this apply to technical Short Answer titles as well? I just received a rewrite telling me that my short answer needed to have three different options for completing a task. The problem is, 200 words isn't nearly enough to explain how to do something three different times with three different types of software.

So, should I try to blaze through a different approach in each step (which will end up being terribly vague) or should I just let the article expire.

User Image

DustinT
Jun 26, 8:17 PM

Question answered on the Answerbag forums.

In short, yes this applies to Short answer format as well.
 First << 1 2 3 >> Last