MY-STE-BUDDY User Guide
🧭 Quick Navigation
What is Simplified Technical English (STE)?
Simplified Technical English (STE) is a controlled language standard designed to improve the clarity and consistency of technical documentation. Originally developed for aerospace, it's now used across many industries.
Key STE Principles:
• Limited Vocabulary - Uses only approved words
• Clear Grammar Rules - Specific guidelines for sentence structure
• Consistent Terminology - One word, one meaning
• Simplified Syntax - Shorter, clearer sentences
• Active Voice Preference - Reduces ambiguity
Key STE Principles:
• Limited Vocabulary - Uses only approved words
• Clear Grammar Rules - Specific guidelines for sentence structure
• Consistent Terminology - One word, one meaning
• Simplified Syntax - Shorter, clearer sentences
• Active Voice Preference - Reduces ambiguity
Prerequisites
• User Account: Register and verify your email
• API Access: Obtain your API key from dashboard
• Active Subscription: Ensure your trial is active
• API Access: Obtain your API key from dashboard
• Active Subscription: Ensure your trial is active
Quick Start
1. Log into your MY-STE-BUDDY account
2. Navigate to the text analysis tool
3. Enter or paste your text
4. Click "Analyze" for instant feedback
5. Review results and apply suggestions
2. Navigate to the text analysis tool
3. Enter or paste your text
4. Click "Analyze" for instant feedback
5. Review results and apply suggestions
📋 Step-by-Step Usage Guide
Access the Tool
Web Interface: Log in at your dashboard
API Access: Use the
API Access: Use the
/api/msbtagtext
endpoint
Prepare Your Text
Format: Plain text works best
Length: Any length (longer texts may take more time)
Language: English only (US English preferred)
Length: Any length (longer texts may take more time)
Language: English only (US English preferred)
Submit for Analysis
Example Input:
"The technician should carefully inspect the colour of the component."
"The technician should carefully inspect the colour of the component."
Review the Analysis
The system returns detailed analysis:
• Word-by-word status
• Sentence structure analysis
• Alternative word suggestions
• Grammar recommendations
• Word-by-word status
• Sentence structure analysis
• Alternative word suggestions
• Grammar recommendations
Apply Improvements
Based on the analysis:
• Replace unapproved words with alternatives
• Simplify complex sentences
• Convert passive to active voice
• Use US English spellings
• Replace unapproved words with alternatives
• Simplify complex sentences
• Convert passive to active voice
• Use US English spellings
Re-analyze (Optional)
• Submit your improved text for verification
• Ensure all recommendations have been addressed
• Iterate until you achieve STE compliance
• Ensure all recommendations have been addressed
• Iterate until you achieve STE compliance
🔍 Understanding Your Results
Approved Words
Status: STE compliant
Action: No changes needed
Example: "the", "is", "good", "simple"
These words are already approved for technical writing
Action: No changes needed
Example: "the", "is", "good", "simple"
These words are already approved for technical writing
Unapproved Words
Status: Should not be used in STE
Action: Replace with alternative
Example: "colour" → "color"
These need to be changed for STE compliance
Action: Replace with alternative
Example: "colour" → "color"
These need to be changed for STE compliance
Unclassified Words
Status: Status unknown
Action: Consider alternatives
Example: Technical terms that may be acceptable
Review these words and consider simpler alternatives
Action: Consider alternatives
Example: Technical terms that may be acceptable
Review these words and consider simpler alternatives
Sentence Analysis
Word Count: Number of words in sentence
Classification: Sentence type (Descriptive, etc.)
Passive Voice: Flags passive constructions
Instructions: Number of command words
Classification: Sentence type (Descriptive, etc.)
Passive Voice: Flags passive constructions
Instructions: Number of command words
🔌 API Integration
🔑 Authentication
All API requests require an API key in the headers:
X-API-Key: your-api-key-here
📡 Basic Request
POST https://my-ste-buddy.com/api/msbtagtext
Content-Type: application/json
{"origtext": "Your text to analyze"}
Content-Type: application/json
{"origtext": "Your text to analyze"}
Python Example
import requests api_key = "your-api-key" url = "https://my-ste-buddy.com/api/msbtagtext" headers = {"X-API-Key": api_key} text = "Your text to analyze" response = requests.post(url, headers=headers, json={"origtext": text}) result = response.json()
JavaScript Example
fetch('https://my-ste-buddy.com/api/msbtagtext', { method: 'POST', headers: { 'X-API-Key': 'your-api-key', 'Content-Type': 'application/json' }, body: JSON.stringify({ origtext: 'Your text' }) }) .then(response => response.json()) .then(data => console.log(data));
PHP Example
<?php $api_key = "your-api-key"; $url = "https://my-ste-buddy.com/api/msbtagtext"; $data = json_encode([ 'origtext' => 'Your text to analyze' ]); $options = [ 'http' => [ 'header' => [ 'Content-Type: application/json', 'X-API-Key: ' . $api_key ], 'method' => 'POST', 'content' => $data ] ]; $context = stream_context_create($options); $response = file_get_contents($url, false, $context); $result = json_decode($response, true); print_r($result); ?>
📋 API Response Structure
🔍 Complete Response Format
The API returns a comprehensive JSON response with detailed analysis:
{
"text": {
"orig_text": "Original input text",
"sentences": [
{
"sentence": "Individual sentence text",
"error": false,
"sentence_inx": 1,
"cluster_nouns": [],
"ispassive": false,
"wordcount": 5,
"charactercount": 25,
"classification": "Descriptive",
"instructions": 0,
"words": [
{
"sentence_inx": 1,
"wordinx": 1,
"wordid": 1234,
"title": "word",
"pos": "NOUN",
"posname": "Noun",
"isnonus": null,
"wordstatus": "1",
"wordstatustxt": "Approved",
"alternatives": null
}
]
}
]
},
"totalwordcount": 5,
"totalcharactercount": 25
}
Top Level Elements
text: Contains original text and sentence analysis
totalwordcount: Total words in entire text
totalcharactercount: Total characters in text
Root structure provides summary statistics
totalwordcount: Total words in entire text
totalcharactercount: Total characters in text
Root structure provides summary statistics
Sentence Elements
sentence: The actual sentence text
error: True if STE compliance errors found
classification: "Procedural" or "Descriptive"
ispassive: True if passive voice detected
wordcount: Number of words in sentence
Each sentence analyzed individually
error: True if STE compliance errors found
classification: "Procedural" or "Descriptive"
ispassive: True if passive voice detected
wordcount: Number of words in sentence
Each sentence analyzed individually
Word Elements
title: The actual word text
wordstatus: "1"=Approved, "0"=Unapproved, 99=Unclassified
pos: Part of speech (NOUN, VERB, etc.)
alternatives: STE-approved alternatives
isnonus: US English equivalent
Every word analyzed for STE compliance
wordstatus: "1"=Approved, "0"=Unapproved, 99=Unclassified
pos: Part of speech (NOUN, VERB, etc.)
alternatives: STE-approved alternatives
isnonus: US English equivalent
Every word analyzed for STE compliance
Word Status Codes
Status "1" - Approved: Use as-is ✅
Status "0" - Unapproved: Replace with alternative ❌
Status 99 - Unclassified: Review and consider alternatives ⚠️
Clear guidance for each word
Status "0" - Unapproved: Replace with alternative ❌
Status 99 - Unclassified: Review and consider alternatives ⚠️
Clear guidance for each word
💡 Processing Response Data
Calculate STE Compliance Score:
approved_words = 0
total_words = data['totalwordcount']
for sentence in data['text']['sentences']:
for word in sentence['words']:
if word['wordstatus'] == '1':
approved_words += 1
ste_score = (approved_words / total_words) * 100
print(f"STE Compliance: {ste_score:.1f}%")
Find Words Needing Replacement:
for sentence in data['text']['sentences']:
for word in sentence['words']:
if word['wordstatus'] == '0' and word['alternatives']:
print(f"Replace '{word['title']}' with:")
for alt in word['alternatives']:
print(f" - {alt['alt_title']}")
💡 Writing Best Practices
DO Use Simple Words
Choose common, approved vocabulary
• Select words from the STE dictionary
• Avoid complex or technical jargon
• Use one word consistently for each concept
Simple words improve understanding
• Select words from the STE dictionary
• Avoid complex or technical jargon
• Use one word consistently for each concept
Simple words improve understanding
DON'T Use Complex Words
Avoid unnecessarily complicated vocabulary
• No synonyms for the same concept
• Avoid industry-specific jargon
• Don't use archaic or formal terms
Complex words create confusion
• No synonyms for the same concept
• Avoid industry-specific jargon
• Don't use archaic or formal terms
Complex words create confusion
DO Write Short Sentences
Aim for 15-20 words maximum
• Break complex ideas into steps
• Use periods, not semicolons
• One main idea per sentence
Short sentences are easier to follow
• Break complex ideas into steps
• Use periods, not semicolons
• One main idea per sentence
Short sentences are easier to follow
DON'T Write Long Sentences
Break up sentences over 25 words
• Avoid multiple clauses
• Don't chain ideas with "and"
• Split complex instructions
Long sentences cause confusion
• Avoid multiple clauses
• Don't chain ideas with "and"
• Split complex instructions
Long sentences cause confusion
DO Use Active Voice
Make the subject do the action
• "The pilot checks the instruments"
• "Remove the cover"
• "The system displays the result"
Active voice is clearer and direct
• "The pilot checks the instruments"
• "Remove the cover"
• "The system displays the result"
Active voice is clearer and direct
DON'T Use Passive Voice
Minimize "was done by" constructions
• Not: "The system is checked by the pilot"
• Not: "The cover should be removed"
• Not: "The result is displayed"
Passive voice is harder to understand
• Not: "The system is checked by the pilot"
• Not: "The cover should be removed"
• Not: "The result is displayed"
Passive voice is harder to understand
DO Use US English
Follow American spelling conventions
• "color" not "colour"
• "center" not "centre"
• "analyze" not "analyse"
Consistency improves readability
• "color" not "colour"
• "center" not "centre"
• "analyze" not "analyse"
Consistency improves readability
DON'T Mix English Variants
Don't combine US and UK spellings
• Avoid: "colour analysis program"
• Avoid: "centre alignment"
• Pick one standard and stick to it
Mixed spelling creates inconsistency
• Avoid: "colour analysis program"
• Avoid: "centre alignment"
• Pick one standard and stick to it
Mixed spelling creates inconsistency
📝 Real-World Examples
🔧
Example 1: Basic Word Replacement
❌ Original Text
"The colour of the component is important."
Issues Found:
• ❌ "colour" → Use "color" (US English)
• ✅ Other words approved
• ❌ "colour" → Use "color" (US English)
• ✅ Other words approved
→
✅ Improved Version
"The color of the component is important."
Result:
• ✅ US English spelling used
• ✅ STE compliant
• ✅ US English spelling used
• ✅ STE compliant
✂️
Example 2: Sentence Simplification
❌ Original Text
"The technician, who should be experienced, must carefully and thoroughly inspect the component that was manufactured yesterday."
Issues Found:
• ❌ Too long (19 words)
• ❌ Complex nested clauses
• ⚠️ Passive voice element
• ❌ Too long (19 words)
• ❌ Complex nested clauses
• ⚠️ Passive voice element
→
✅ Improved Version
"An experienced technician must inspect the component.
The component was manufactured yesterday."
The component was manufactured yesterday."
Result:
• ✅ Two clear sentences (8 + 7 words)
• ✅ Simple structure
• ✅ One idea per sentence
• ✅ Two clear sentences (8 + 7 words)
• ✅ Simple structure
• ✅ One idea per sentence
📖
Before Analysis
Common Issues:
• Complex vocabulary
• Long sentences
• Passive voice
• Mixed English variants
Typical technical writing problems
• Complex vocabulary
• Long sentences
• Passive voice
• Mixed English variants
Typical technical writing problems
✨
After Improvement
STE Compliant:
• Simple, approved words
• Clear, short sentences
• Active voice preferred
• Consistent US English
Professional, accessible writing
• Simple, approved words
• Clear, short sentences
• Active voice preferred
• Consistent US English
Professional, accessible writing
💼
Industry Applications
✈️ Aviation:
Maintenance manuals, pilot instructions
Maintenance manuals, pilot instructions
🏭 Manufacturing:
Assembly instructions, safety procedures
Assembly instructions, safety procedures
💻 Software:
User guides, technical documentation
User guides, technical documentation
⚕️ Medical:
Device instructions, safety warnings
Device instructions, safety warnings
🏥 Healthcare:
Patient instructions, treatment protocols
Patient instructions, treatment protocols
STE improves comprehension across all technical fields
🆘 Support and Resources
📞 Getting Help: Use our contact form for support
📚 Documentation: This guide and API docs
⚙️ Account Issues: Manage your account and API keys
📖 STE Standard: Official ASD-STE100 specification
🎯 Success Tips: Practice regularly to improve your STE writing
✅ Start Writing Better Technical Documentation
MY-STE-BUDDY makes it easy to create clear, consistent, and compliant technical documentation using Simplified Technical English standards.