Simplified Technical English Software & Services
Submitted by login on Wed, 2009-07-29 22:55
 

Simplified Technical English for consumer and industrial companies

All Industries All Industries All Industries

 

Turn off engines not required.

One small single sentence that can have big consequences, as it can have several meanings. It could be interpreted as ‘turn off the engines that are not required’, but it could also mean that turning off the engines is not required at all. The fact that this sentence could be misinterpreted could have potentially dangerous consequences. And it’s also a fact that this sentence is just one out of the thousands of sentences that make up the technical information we have to provide to our end users.

Furthermore, we often have to provide documentation in the native language of the countries to which we export. So if the English source is not clear, the translated versions are certain to contain errors, ambiguities and misinterpretations.

Ambiguity in technical writing will confuse and frustrate users. They may cause danger, damage and product liability claims, let alone cost a company a lot of money in translations.

Consequently, we must provide users with information that is appropriate in language, terminology and educational level.

To do this, we’ll need to standardize our general vocabulary as well as our corporate terminology.  The most established Controlled Language standard for good writing practices is Simplified Technical English.

Simplified Technical English (STE)

Created in the 80s, STE is a long-term and comprehensive initiative designed to standardize the way in which technical documentation is written. It eliminates ambiguity by applying the key principle that one word can only have one meaning. 

Originally created for technical information in the aerospace and defence industries, STE has been adapted by many other industries over the past 30 years, including medical, automotive, IT, pharmaceutical, machinery and telecommunication. Many of these companies used the STE specification as a basis for their controlled language efforts and customized it where necessary, resulting in their own controlled language standard.

Benefits included:

  • Improved safety
  • Avoidance of costly problems as a result of misinterpretations
  • Reduced translation cost
  • Up to 40% reduction in words used
  • Improved User Experience
  • Efficiency in authoring
  • And much more!
 

Downloads

Learn how to dramatically improve the quality of your technical information and save considerable cost at the same time!

 
 
 

Why choose Simplified Technical English as a basis for your controlled language efforts?

Simplified Technical English is regarded as the single international standard for creating unambiguous information. Not only will Simplified Technical English allow you to comply with corporate style guides, it will further increase the readability and quality of information, and further increase cost savings.

Originally intended for the aerospace and military industries (ASD-STE100), Simplified Technical English can be applied to all fields of industry.

Simplified Technical English includes a base dictionary and a set of writing rules. As the base dictionary includes about 900 approved words and 2,000 unapproved synonyms, which do not include technical names, it will be necessary to add company and industry specific terminology to the base dictionary (see Steps of Implementation on page 7).

Using the Simplified Technical English specification as a basis offers many benefits:

  • Simplified Technical English is derived from an aerospace and defense standard, which applies to almost all standards that we know today, because these industries are subject to the highest levels of quality and safety and involve technology from most industries 
  • Simplified Technical English is an international standard, designed by companies worldwide to make technical text easy to understand by both native and non-native English speakers (other style guides will allow the use of ambiguous words, as long as they are being used consistently)
  • Because Simplified Technical English is based on aerospace and defense standards, it is strict by nature with 57 writing rules and a limited vocabulary of approximately 900 approved words and approximately 2,000 non-approved words with assigned synonyms. This is good news for companies in any industry, because you can use a well-maintained standard and will not have to 'reinvent the wheel.' Instead, you can be more flexible, according to your requirements such as meeting your corporate style guides.

HyperSTE Controlled Language

Tedopres builds on 35 years of experience in the field of technical information and has helped many companies save cost and communicate more effectively with their audience. In addition to offering content management and translation services, Tedopres developed HyperSTE, the industry's leading solution for controlled language authoring thanks to its flexibility, ease of use, and cost saving benefits. HyperSTE Controlled Language software helps you deliver complex information in the simplest and most effective way. By giving you tools for quality assurance and quality measurement, HyperSTE results in many benefits, including:

  • Improved readability, quality and consistency Improvement in efficient and cost-effective writing Reduced time to market
  • Translation cost savings, up to 30% per language Terminology Management, in multiple languages
  • Maximizing benefits from structured authoring (DITA), XML and Content Management

HyperSTE is currently being used by a large variety of industries, including software, medical, pharmaceutical, semiconductor, automotive, banking, financing, insurance, machinery and electrical. We have outlined some industry examples below, which shows how technical content can be communicated more effectively. A typical implementation includes:

  • Dictionary development, in order to standardize on company specific terminology
  • Training of technical writers and engineers on the rules of Simplified Technical English authoring
  • HyperSTE Controlled Language, the leading checker software to ensure compliance with writing standards and corporate terminology. HyperSTE Controlled Language (CL) is generally regarded as a “less strict” version of HyperSTE in comparison with the ASD-STE100 version. It does include all features such as reporting and the ability to export interactive feedback to HTML, but less writing rules are enabled to gain more flexibility. If you are not an aerospace or defense companies, or in case you do not have an ASD-STE100 requirement, HyperSTE Controlled Language is for you.

For more information on how HyperSTE can help you save cost and communicate more effective, please request a free demonstration or content quality check by contacting us.

Industry Examples

BEFORE

The firewall is the world’s first key-upgradeable integrated security appliance. Its Intelligent Layered Security architecture delivers multiple layers of protection that work together to detect and block threats from attacking your network. Stateful firewall, VPN, intrusion prevention, application filtering, spam blocking, and content filtering are all integrated into a single appliance and managed through a common interface. The firewall X is a superior security device designed with the future in mind. This platform has a streamlined 1 U form factor, increased processing power, higher memory and port count compared to existing firewall devices. There is an LCD display and front panel controls that allow access to status information without going to the management station. The firewall X even has an external hard drive bay for storage expandability in future applications. As your security requirements grow, the firewall X platform is fully upgradeable to a higher performing model by simply entering a license key. Additionally, you can purchase a license key to activate additional network ports and high availability functionality to support your network and reliability requirements. As new security services become available for the firewall X to combat against future threats, a simple download and license key is all that is needed to enable your firewall X to provide added layers of defense. The firewall X is a rack-mountable device that is easily installed into your network. For information on installing the firewall X, see the firewall QuickStart Guide or the “Getting Started” chapter in the User Guide.

AFTER

The firewall is the first security device that can use upgrades by a license key. The device has different layers of protection that find and prevent damage to your network.
The firewall has these components:
• A stateful firewall
• A VPN
• A protection against intrusion
• A software program filter
• A spam filter
• A content filter.

You can control all the components from the same interface. With the front panel controls you can find the status information from an LCD display. The firewall X also has an external hard-drive bay to get upgrades. You can upgrade the performance of the firewall X with a new license key and new software.

You can enable:
• A new network port
• The high availability software
• A new security layer.

You can install the firewall X in a rack. The firewall X is easy to install on the network. For more data on the installation of the firewall X, refer to the firewall QuickStart Guide or the “Getting Started” chapter in the User Guide.

The BEFORE example has 248 words, the AFTER example not only has only 176 words (reduction of almost 30%), it also has better structure and  is written in a clear and concise way.

BEFORE

Complete tasks below before each startup.

  • Switch off the power to the hardware if power is on.
  • Remove any obstructions (tubes, tips, screws, etc.) on the track.
  • Ensure all drawers are empty.
  • After a fast shutdown (Exit Immediately), remove any sample tubes from the output trays and fill any partially processed input trays.
  • After a fast shutdown, an accidental shutdown or power loss, remove the tip from the transfer arm.

Press the Power On/Off button on the Input/Output module to turn on the power to the hardware.

Select  from the computer screen to start.

CAUTION

When the system is started or the drawer is unlocked, you must verify all drawers are empty. If not, the system can put a sample tube in a location in use which can cause a biohazard condition, loss of sample, or cross contamination.

Select  at the dialog box to confirm all drawers are empty.

Ensure the system is in Ready mode to process samples.

  • Wait for the system to home and activate all components and modules.
  • The hardware is ready when the green button above each drawer flashes.

Open and close all drawers until the lights do not flash presentative.

AFTER

Complete these tasks before each startup.

  • Make sure that the power of the hardware is OFF.
  • Make sure there is no blockage (tubes, tips, screws) on the track.
  • Make sure that all the drawers are empty.
  • After a fast shutdown (Exit Immediately), make sure that the output trays are empty and the input trays are full.
  • After a fast shutdown, an accidental shutdown or a loss of power, remove the pipette tip for the liquoter from the transfer arm.

Push the Power ON button on the Input/Output module to start the hardware.

Select  X to start the device.

CAUTION

Make sure that all the SIQ drawers are empty when you start the system or when the Priority/SIQ drawer is unlocked. If the SIQ drawers are not empty, there is a risk of injury, loss of sample, or cross contamination.

Select  X at the dialog box to make sure that all the drawers are empty.

Make sure that the system is ready to process the samples.

Activate all components and modules. The hardware is ready when the green button above each drawer flashes.

Open and close all drawers until the lights are off.

 

BEFORE

Managing the System Remotely

You can configure, manage, and monitor the system from a computer using the system’s web interface, VXX Web. You can also use the XYZ Global Management System, SNMP, or the API commands.

Your choice of management tool depends on your network environment:

  • VXX Web requires only a web browser. 
  • XYZ Global Management System requires the Global Management System application to be installed on your network. 
  • SNMP requires network management software on your network management station.
  • For more information about the API commands, refer to the Integrator’s Reference Manual for the VXX Series.

Using VXX Web

You can use VXX Web to perform most of the calling and configuration tasks you can perform on the local system. 

Accessing VXX Web

To configure your browser to use VXX Web:

  1. Be sure that you use Microsoft Internet Explorer 6.0 or later as your web browser and that you have Java 1.2 or later installed.
  2. Configure these settings:
  • Allow cookies: Enabled
  • Force pages to reload on every visit to a page: Enabled

To access the system using VXX Web:

  1. On a computer, open a web browser.
  2. In the browser address line, enter the system’s IP address, for example, http://10.11.12.13, to go to VXX Web.  If Security Mode is enabled on the system, you must use secure HTTPS access, for example, https://10.11.12.13. Click Yes in the security dialog boxes that appear.
  3. Enter admin as the user name, and enter the remote access password, if one is set. 

AFTER

How to Manage the System remotely

You can use the web interface, VXX Web, to configure, manage, and monitor the system from a computer. You can also use the XYZ Global Management System, SNMP, or the API commands.

Use the correct management tool for your network:

  • For VXX Web, only a web browser is necessary. 
  • For the XYZ Global Management System, the Global Management System application must be on your network. 
  • For SNMP, network management software must be on your network management station.
  • For more information about the API commands, refer to the “Integrator’s Reference Manual for the VXX Series”.

Use VXX Web

You can use VXX Web to do most calling tasks and configuration tasks that are available on the local system. 

Get access to VXX Web

To configure your web browser to use VXX Web:

  1. Make sure that you use Microsoft Internet Explorer 6.0 or higher as your web browser. Make sure that you have Java 1.2 or higher.
  2. Configure these settings:
  • “Allow cookies”: Enabled
  • “Force pages to reload on every visit to a page”: Enabled

Use VXX Web to get access to the system:

  1. On a computer, open a web browser.
  2. In the address bar of the web browser, enter the IP address of the system, for example, http://10.11.12.13, to go to VXX Web. If Security Mode is enabled on the system, you must use “secure HTTPS access”, for example, https://10.11.12.13. Click Yes in the security dialog boxes that show.
  3. Enter admin as the user name, and enter the remote access password, if one is set.

Plain Language (also known as Plain English) is an initiative by the US Federal Government to improve its communications to the American public. Applicable types of documentation include tax forms (IRS), legislative writing, FDA (Food & Drug Administration) documents, and any other types of information the US Government uses to inform its civilians.

BEFORE

When the FTF penalty and the FTP penalty under IRC section 6651(a)(2) apply at the same time, the FTF penalty is reduced by the amount of the FTP penalty under IRC section 6651(a)(2). In other words, FTF is then assessed at a rate of 4.5% a month and FTP at .5% a month. When both FTF and FTP apply for 5 months, the maximum FTF penalty rate is 22.5%.

AFTER

When the FTF and the FTP penalties under IRC section 6651(a)(2) apply at the same time, the FTF penalty is decreased by the amount of the FTP penalty under IRC section 6651(a)(2).

The FTF penalty is then assessed at a rate of 4.5% per month and the FTP penalty is then assessed at a rate of 0.5% a month. When the FTF and FTP penalties apply for 5 months, the maximum FTF penalty rate is 22.5%.