Have you recently solved a technical problem that had frustrated you daily, or figured out how to add something that helped your whole team, or proposed a process that your bosses bragged about to their bosses? That's something that other developers need to hear about, so the developerWorks Rational team will be glad to hear from you.
Check the Resources section here for excellent articles that dig into the details of writing for developerWorks. If you're still in the thinking-about-it stage, read on to learn what the editors look for and get their insider tips.
Michael O'Connell, Editor-in-Chief and Editorial Director at IBM developerWorks
Sera Lewis, Manager, Rational Web Marketing and developerWorks Rational
Robin Wood, Acquisition Editor and Project Manager developerWorks Rational
Q: What do you consider in deciding whether to accept a proposal?
Sera: When assessing content, I look for it to meet two goals. First, that it is something that answers a reader's question or that can help readers solve a problem that they face day to day. A how-to article can be about how to use a tool or how to think about something, not just how to solve a technical problem. So it could be about something as small as tweaking a GUI or as big as redefining the business process of your company.
It needs to be something that makes a reader's life easier. Beyond that, I want it be interesting, so the abstract needs to immediately engage me. If the author can't be interesting in one paragraph, it's unlikely that the full article will be interesting. The abstract should state the problem and state it clearly enough that someone not familiar with the problem can understand at least the scope of it or at least understand it enough to know whether it's related to something they're working on.
Michael: My mantra has been "relevance." Focus on the wants and needs of the developers and IT professionals, what they value most. Characteristically, that means technical hands-on, how-to content. Tell the reader how to do something and show them with examples. That could be how to craft software, solve technical problems, or improve performance of the software. Even if it's a very short article about a very small piece of the process, if it's a common problem or a critical issue, we need to offer that information to our readers. We want to focus on true real-world issues that people are grappling with, as opposed to hypotheticals. And I agree with Sera: We want to answer questions and help readers solve problems.
Robin: developerWorks Rational uses a proposal rating system that ranks the product, category, topic, alignment with Rational and IBM goals, author's credentials, quality of the abstract, and the estimated time factor to produce the article. Everything's weighted. Based on how the proposal comes in and what I plug into the tool, a number is assigned. And based on that number, if it's in the range to accept, I do.
The content shouldn't be marketing-oriented, and the subject of the article needs to mean something to our audience. We have certain products and categories that get priority at different times. This means that proposals related to those categories are going to rank higher than something that comes in about an older product, such as Rational Purify, for example.
Q: How can authors make their articles more appealing?
Michael: How you position it can often make all the difference. Broader objectives help. For instance, will it interest people who aren't using the product yet or only those who already are? Is it relevant regardless of what software they're using?
Although broader objectives help draw a wider readership, ultimately we want technical how-to content, and that invariably means getting tightly focused so you can discuss technical details and a specific task and show software developers and related IT professionals how to accomplish that task, step by step. If you stay broad, it's hard to provide the technical details that our community often values most.
And of course, accuracy, quality, and clarity are important. If an article contains code that has a bug in it, fragments rather than complete sentences, typos, figures that are flawed, or links that are broken, it hurts the credibility of the article, as well as developerWorks and IBM. Readers will become skeptical and not continue reading.
Finally, make sure that the topic is either timely (focused on today's top topics and emerging technologies) or timeless ("evergreen" issues that remain pertinent over time, such as security or optimization). Also, make sure that the information is up-to-date.
Sera: A successful piece is self-contained. It clearly states the problem, the solution, and the steps between.
Choose topics that are emerging technologies or that we haven't covered as much in articles already in our library. That could be something like a process, such as agile development, or products that are newer in the IBM portfolio, even if they aren't our newest products. For older products, because we already published so much about their features and functions, it would have to be about something exceptional, new, or unique.
Robin: When somebody submits a proposal, it should include a brief paragraph that says what the article is about, information about the author's qualifications, and who the target audience is.
The content and structure both affect my evaluation. If the content is just a list of "do this, do this, do this," I'm not so keen on it. I prefer the articles that say why you're going to do something and then explain how to do it. Screenshots help. They need to be clear, but if they're not needed, don't include them.
Q: Do you work with first-time authors?
Sera: You need to be a strong thinker to write a developerWorks article, because you need to articulate complicated concepts in a simple way. But don't let concerns about your writing skill or command of written English hold you back. We have many, many technical authors whose native language isn't English or whose strength is their technical expertise, not their writing. That's why we have editors.
If you are on the edge about submitting an idea, submit it. If we're not interested, we'll say so.
- Read the developerWorks editorial policy, which explains what we publish and what we don't.
- Study the kinds of articles developerWorks publishes by subscribing to the IBM developerWorks newsletter, a weekly update on the best of developerWorks tutorials, articles, downloads, community activities, webcasts and events.
- Search the Technical Library in the Rational software area on developerWorks to see what we've already published that's related to the article that you plan to propose. You might want to include links to related articles in the Resources section of your article.
- Check to see what currently ranks high on the editors' content wish list. Just because your idea isn't there doesn't mean that they won't be interested, however.
- Submit a proposal first, and don't start writing until you get the go-ahead.
- Be sure to read the instructions on these pages before you start writing:
- Writing for IBM developerWorks: Ready, set, publish! Best practices for preparing your content for publishing on the developerWorks site. Your guide to the policies, practices, and requirements for getting your article published on the developerWorks site.
- Web content accessibility for authors: Learn how to write and format your content to comply with federal laws and corporate policies that guarantee accessibility for all readers.
- Illustrating your article or tutorial for developerWorks: Learn how to create and deliver effective graphics such as screen captures, diagrams, and photographs to enhance and help explain your content.
- Read the Highlighting and Procedures sections of the IBM Style guide, as a minimum. The PDF version is updated quarterly. (This requires IBM intranet access, but it will soon be published by IBM Press as a book.)
- Authoring with the developerWorks Word or Writer templates: Download the developerWorks Microsoft Word or OpenOffice Writer templates to the information that you need to use the templates to compose your article. If you'd rather work in XML, you'll need to know IBM Style basics and then read Authoring with the developerWorks XML templates before you download the developerWorks XML templates to compose your article.
- Plagiarism: Review tips for avoiding it at the Plagiarism.org Web site.
- Share your knowledge and help others who use Rational software by writing a developerWorks article. You'll get worldwide exposure, RSS syndication, a byline and a bio, and the benefit of professional editing and production on the developerWorks Rational website.
- Follow Rational software on Facebook and Twitter (@ibmrational), and add your comments and requests.
- Ask and answer questions and increase your expertise when you get involved in the Rational forums, cafés, and wikis.
- Connect with others who share your interests by joining the developerWorks community and responding to the developer-driven blogs.