HOW TO USE

How-To Guide

Follow this simple workflow to check and improve your ASD-STE100 compliance efficiently.

Prepare Text

Run Analysis

Improve & Recheck

QUICK START

From draft to compliant technical text in a few practical steps

  • Use complete sentences
    Submit clear technical instructions, procedures or descriptions in plain text format.
  • Review flagged items
    Focus on ambiguous wording, long sentences and terms outside approved usage.
  • Iterate quickly
    Apply recommendations, run a new check and refine until the text is aligned.

BEST PRACTICE

Check content section by section instead of pasting an entire large manual at once. Smaller batches make review faster, clearer and easier to validate with your team.

STEP-BY-STEP

Workflow for consistent results

1. Create your account

Register using your business email, complete email verification and sign in to access your workspace and account features.

2. Prepare your source text

Copy the technical text you want to validate. Remove unrelated boilerplate so the analysis focuses on the content that matters.

3. Submit for analysis

Paste the text into the checker and run the compliance analysis. The platform evaluates wording and structure against STE guidance.

4. Review the findings

Inspect each issue category and suggested alternative. Prioritise critical clarity and consistency issues first.

5. Apply corrections

Update your text based on the recommendations while preserving technical accuracy and intended meaning.

6. Re-run until compliant

Run another pass after edits and repeat until the document quality is aligned with your operational writing standards.

ACCOUNT & API

How the API helps you (simple version)

1. You send a sentence

You send one sentence to MY-STE-BUDDY for checking. Think of it like asking: “Is this sentence compliant?”

2. We check it instantly

The system analyzes your words and sentence structure against ASD-STE100 writing rules.

{
  "sentence": "Make sure that the valve is open."
}

3. You get clear feedback

You receive a result with issues found, rule names, and suggestions to improve the sentence.

{
  "sentence": "...",
  "word_count": 8,
  "passive": false,
  "words": [...],
  "asd_ste100": { "rules": {...} }
}

4. Your account keeps it secure

When security is enabled, each request must include your account email and API key.

  • x-user-email
  • x-api-key

5. Works with your tools

You can connect the API to your editor, CMS, or internal workflow tools for automatic checks.

Current API URL: https://api.my-ste-buddy.com/api/v1/nlp/analyse

curl -X POST https://api.my-ste-buddy.com/api/v1/nlp/analyse \
  -H "Content-Type: application/json" \
  -d '{"sentence":"Make sure that the valve is open."}'

6. If something fails

Common response codes:

  • 400: sentence format is not valid (too long or more than one sentence)
  • 401: login details or API key are missing/invalid
  • 429: too many requests in a short time

Manage your profile

Update personal details, organisation information and contact preferences from your profile page at any time.

Generate an API token

Create or regenerate your API token securely from your account profile to connect internal systems.

Protect your credentials

Treat API tokens like passwords: store them securely, rotate when needed and avoid sharing in public channels.