Checklist

Check your article/blog post against this checklist before you move your content into the reviewor ready workflow state.

#0: Do read the Contributor Guide in it's entirety.

Seriously, do this.

#1: Don't start your article with a header.

It must start with an introductory paragraph of text (the "teaser"). Also, don't leave line breaks or whitespace before the first block of text.

#2: Do insert a teaser...

... after your introductory paragraph(s). The text before the teaser break is displayed in the Content Activity Stream. Read more...

#3: Do use the standard headers styles (H2-H4).

If your article has a relatively flat structure, then use H3 for your headings, otherwise use H2 for sections, and H3 for sub-sections. H4 is (rarely) used for sub-divisions below H3. Do not try to simulate a header using bold, underline etc. Read more...

#4: Don't use JPEG for screenshots.

Use PNG or GIF instead. JPEG should only be used for photograph-type images.

#4a: Don't ever upload .bmp files.

Under any circumstances.

#5: Don't upload Word .doc files.

Use PDF instead. On Windows, you can install the free CutePDF driver. On Mac OS, use PDF > Save as PDFin the Print dialog. 

#6: Do be consistent in the use of capitalizion.

It's JAR file, or .jar file, not Jar file, or jar file. And when you choose one form of capitalization, use the same form throughout your article. And always name products with correct capitalization, e.g. Teradata Workload Designer, not Teradata workload designer.

#7: Do use the inline <code> style for file names, variables, values...

... literals, button names, menu items, etc. In the content editor, select your text, and choose Computer Codefrom the Stylesdrop-down menu. Use this style instead of "quotes", bold, or italic for these kinds of elements: it helps distinguish these literals from the body text. Some examples:

  • "Copy jdbc.jarinto /usr/bin/java/lib, and restart the server."
  • "Select File > Save As...to save a copy of the file."
  • "Set com.teradata.viewpoint.alert_levelto ALLto see all error messages."
  • "If the current active ruleset is Production.v6, then we would choose Clone from the drop down menu associated with Production.v6."
  • "Then click on the Create Workload button to create a workload."

Sometimes it's not clear if one should use inline codefor an Item, or if it might be better to italicize that Item. We still haven't figured that out entirely.

#8: Do use the Code Block tool for chunks of SQL, Java, tool output, etc.

It makes it easier for the user...

-- ... to see that this is actual code / pseudo-code / tool output,
-- and not part of the body text.

SELECT * FROM easy_to_read;

There are styles for SQL, Java, C++, etc, as well as a Plain style. Read more...

#9: Do use italics the first time you mention a product or concept.

When you introduce a named item (noun, particularly product names), e.g. Teradata Workload Designer, you should italicize it to establish that it is a distinct entity. On subsequent mention, italicization is optional.

#10: Do use the Content ID for links to other DevX content.

The URL of a DevX article is generated from the article title. The title can change, so the URL can change. The article's Content ID(which is the first item in the Contributetoolbar) does not change, so the Canonical URL should be used instead; this is simply /node/CONTENT_ID. So:

  • BAD: <a href="http://developer.teradata.com/blog/carrie/2012/01/enforcement-priority-soft-hard-or-just-window-dressing">Carrie's article</a>
  • GOOD: <a href="node/9820">Carrie's article</a>

An exception (for technical reasons) is when you're referencing an HTML anchor in an article (e.g. myarticle#my-section); in this case, use the generated URL. However, be sure to use a relative path, e.g. /general/my-article#my-section - that is, don't include the http://developer.teradata.com/ prefix.

#11: Don't use double-space between sentences.

Please, just don't do this. You're not working on a typewriter. Also, don't add extra line-breaks between paragraphs.

#12: Don't capitalize The Entire Title Of Your Article.

Every publishing house has its own take on this, but the DevX House Style™ is to only capitalize the first word, and any proper nouns, concepts, etc..

  • BAD: Selecting The Right Operator To Use For Your TPT Job
  • GOOD: Selecting the right operator to use for your TPT job

#13: Do add a cover-image for your article.

If you don't, your article can't be featured in the carousel at the top of the page. And add an image attribution. If you don't know what this means, click here...

#14: Don't discuss future product releases.

If we're currently shipping TD14.0, don't write about features in TD14.10. If in doubt, or if you need to respond to a query from a user about future features, please discuss with your management first.

#15: Don't get too excited (!!)

If you have a product announcement, it should be "Product X 14.0 now available", and not "Product X 14.0 - now available!!". This isn't a tabloid newspaper.

#N: Do put your article into the 'ready' workflow state...

... only when you've ticked off all the items on this checklist. Then the Channel Owners can publish your content. If you don't move the content into ready, we won't know to publish it.

#N+1: Do share your article via the social tools.

After you pubilsh, click on the Facebook "Like", Google+, and LinkedIn buttons to get your article noticed out in the world.