Quick Start Guide

Get up and running with MY-STE-BUDDY in just 5 minutes. Follow these simple steps to start analyzing your technical documentation for ASD‑STE100 compliance.

Estimated Time: 5 minutes

What You'll Learn

This guide will walk you through everything you need to know to start using MY-STE-BUDDY effectively:

Getting Started

Access the STE Analyzer and understand the interface

Text Input

Learn how to input your text for analysis

Understanding Results

Interpret compliance reports and recommendations

Best Practices

Tips for effective STE compliance analysis

Step-by-Step Instructions

1

Access the STE Analyzer

Navigate to the STE Analyzer tool and familiarize yourself with the interface.

How to get there:

Tip: The STE Analyzer works best with Chrome, Firefox, or Edge browsers. Make sure JavaScript is enabled for full functionality.
2

Enter Your Text

Input the technical documentation you want to check for STE compliance.

Text input options:

  • Direct typing: Type or paste your text directly into the main text area
  • Copy & paste: Copy text from Word, PDF, or other documents
  • Best format: Plain text works best - formatting will be preserved in analysis

What to check:

  • Procedures and instructions
  • Technical descriptions
  • Maintenance manuals
  • Safety guidelines
  • Product documentation
Good to know: You can analyze up to 10,000 characters at once. For longer documents, break them into sections.
3

Run the Analysis

Start the ASD‑STE100 compliance analysis process.

Starting the analysis:

  1. Click the "Check Text" button
  2. Wait for the analysis to complete (usually 2-5 seconds)
  3. The system will process your text against all 53 ASD‑STE100 rules

What happens during analysis:

  • Word checking: Each word is validated against the STE dictionary
  • Sentence analysis: Structure, length, and complexity are evaluated
  • Grammar checking: Passive voice, verb tenses, and noun clusters are identified
  • Rule validation: All 53 STE rules are applied to your content
Processing Info: The analysis uses advanced natural language processing to understand context and provide accurate recommendations.
4

Review Your Results

Understand the compliance report and identify areas for improvement.

Understanding the results:

Overview Statistics

  • Compliance Score: Overall percentage of STE compliance
  • Word Count: Total words and character count
  • Issues Found: Number of violations requiring attention
  • Sentence Analysis: Breakdown by sentence type and complexity

Detailed Breakdown

  • Word-level issues: Non-approved words highlighted in red
  • Sentence problems: Long sentences, passive voice, complex structures
  • Rule violations: Specific ASD‑STE100 rules that were violated
  • Suggestions: Recommended alternatives and improvements
Pro Tip: Focus on the highest-impact issues first - non-approved words and sentence structure problems typically have the biggest effect on clarity.
5

Apply Improvements

Use the recommendations to improve your documentation's STE compliance.

Making improvements:

Word Replacements

  • Click on highlighted non-approved words
  • Review suggested alternatives from the STE dictionary
  • Choose the most appropriate replacement for your context

Sentence Structure

  • Long sentences: Break into shorter, clearer statements
  • Passive voice: Convert to active voice where possible
  • Complex structures: Simplify using STE guidelines

Iterative Improvement

  • Make changes to your original text
  • Re-run the analysis to see improvements
  • Continue until you achieve your desired compliance level
Important: Always consider context and meaning when applying suggestions. The goal is clarity, not just rule compliance.

Best Practices for Success

Start Small

Begin with shorter sections (1-2 paragraphs) to understand the tool and build familiarity with STE principles.

Work Iteratively

Check, improve, and re-check your text. Each iteration will bring you closer to full STE compliance.

Learn the Rules

Familiarize yourself with ASD‑STE100 rules to understand the reasoning behind suggestions.

Balance Compliance

Aim for clarity and accuracy first. Perfect STE compliance should enhance, not compromise, your message.

Consider Your Audience

Remember that STE is designed to improve communication with international and non-native English speaking audiences.

Track Progress

Monitor your compliance scores over time to see improvement in your technical writing skills.

Common Issues & Solutions

Most Common Problems

1. Non-Approved Words

Issue: Using words not in the STE dictionary

Solution: Replace with approved alternatives or add technical terms to your glossary

2. Long Sentences

Issue: Sentences exceeding 20 words

Solution: Break into shorter sentences, each with one main idea

3. Passive Voice

Issue: Using passive constructions that obscure the actor

Solution: Rewrite in active voice: "Remove the bolt" instead of "The bolt should be removed"

4. Noun Clusters

Issue: Multiple nouns grouped together

Solution: Use prepositions: "the cover of the fuel tank" instead of "the fuel tank cover"

5. Inconsistent Terminology

Issue: Using different words for the same concept

Solution: Create and follow a terminology list for your document

Ready to Start Analyzing?

Now that you know the basics, try the STE Analyzer with your own technical documentation.

Start Analyzing Now Learn More About STE

Need More Help?