Services : Writing : Technical Writing : Best Practices : Details

Technical Writing Best Practices

Located in Atlanta, ProEdit provides technical writing services throughout the U.S. and abroad. ProEdit's technical writing services reflect the industry's best practices. Here are some of the best practices we employ:

• Create a quick reference chapter, section, or guide. A quick reference summarizes the most common user procedures, which is very helpful to users. TVs, DVD players, and computers are often equipped with a "Getting Started" guide. A quick reference helps your users get started without having to comprehend a large amount of information beforehand.

• Create a glossary of terms. Think about all of the times that you wish you had a glossary while reading something. We can create a glossary of definitions of important terms in your documentation.

• Create comprehensive indexes. An index helps users find the information they need in the documentation.1 The number of pages of single-column index should be approximately 10% of the total length of the document.

• Edit the documentation. Then, edit it again. The importance of editing cannot be overstated. Inconsistency in technical writing affects credibility and the user's perception of the documentation.

Learn more about the technical writing industry's best practices.

Additional Information

• ProEdit's Technical Writing Services
• Learn more about ProEdit's technical writing process.
• About Technical Writing

Do you need "the best" technical writing services? Give us a call at (888) PROEDIT.

Learn more about ProEdit's technical writing services.
Are you interested in joining ProEdit's technical writing services team in Atlanta? Learn more about our employment opportunities.

1 GNOME Documentation Style Guide V1.3. Sun Microsystems. 2003. http://developer.gnome.org/documents/style-guide/c2794.html#indexing-1

(888) PROEDIT • © Copyright 2007, ProEdit, Inc. • Sitemap