๐ฆพ Simplified Technical English (STE) proves to be a vital and versatile standard for technical communication. Its well-balanced set of rules, extensive dictionary, and guidelines for terminology make it an essential tool for writers seeking greater control over their technical English communications.
This presentation is a summary of all the STE case studies presented by Shumin Chen where the concept of STE and its most practical applications were introduced at the first tekom Netherlands meeting this year.
Tekom Netherlands | The evolving landscape of Simplified Technical English by Shumin Chen, January 2024
1. Tekom Netherlands ๐ณ๐ฑ |
The evolving landscape
of Simplified English
Shumin Chen
Head of STE Training & Implementation Shufrans
TechDocs
2. About me
โ Documentation professional providing training in the field
of international standards.
โ Leading expert in ASD-STE100 Simplified Technical
English training & implementation.
โ Industries that I engage with:
โข SaaS
โข Healthcare: Medical Equipment & Devices
โข Life Sciences: Diagnostics, Genomics
โข Heavy Industry: Mining, Construction Equipment.
@STE_trainer, Shumin Chen
3. Whatโs your familiarity with
STE at this point?
โ
Click Present with Slido or install our Chrome extension to activate this
poll while presenting.
4. Portal site for developers: Channel access tokens
The LINE Developers site is
a portal site for developers.
It contains documents and
tools that will help you use
our various developer
products.
What are channel access tokens?
For services available on the Internet,
authentication via IDs and passwords
is often used as a means of verifying
whether a person has permission to
use the service. LINE Developers
also verifies and confirms that a
person has permission to use a
specific channel. However, entering
an ID and password every time you
use a channel (for Messaging API
channels, every time you use an
endpoint in the Messaging API) takes
too much effort and is therefore
suboptimal.
That is why LINE Developers uses
channel access tokens as a means of
authentication for channels. If you
send the correct channel access
token to LINE Developers, you are
deemed to have permission to use
the channel.
Copyright ยฉ 2023 by Shufrans TechDocs. All rights reserved. All trademarks acknowledged.
5. Portal site for developers: Channel access tokens
What are channel access tokens?
Internet services, authentication (with
IDs and passwords) is frequently
used to make sure that the user has
permission. LINE Developers will also
make sure that a user has permission
to use a specified? channel.
EACH TIME YOU USE A CHANNEL
OR AN ENDPOINT IN THE
MESSAGING API, YOU WILL
ENTER AN ID AND PASSWORD.
TO MAKE THIS EASIER, LINE
Developers use channel access
tokens AS AN ALTERNATIVE.
WHEN you send a request with the
correct channel access token, LINE
Developers WILL KNOW THAT you
have permission to use the channel.
Copyright ยฉ 2023 by Shufrans TechDocs. All rights reserved. All trademarks acknowledged.
What are channel access tokens?
For services available on the Internet,
authentication via IDs and passwords
is often used as a means of verifying
whether a person has permission to
use the service. LINE Developers
also verifies and confirms that a
person has permission to use a
specific channel. However, entering
an ID and password every time you
use a channel (for Messaging API
channels, every time you use an
endpoint in the Messaging API) takes
too much effort and is therefore
suboptimal.
That is why LINE Developers uses
channel access tokens as a means of
authentication for channels. If you
send the correct channel access
token to LINE Developers, you are
deemed to have permission to use
the channel.
6. In a few words, what are some of the
biggest challenges that youโre facing now
as a technical writing team ?
โ
Click Present with Slido or install our Chrome extension to activate this
poll while presenting.
8. Why Simplified English?
@STE_trainer, Shumin Chen
โขTechnical documentation is mostly
written in English.
โขHowever, English has a huge vocabulary
(700,000 words) and complex grammar.
โขMany words are redundant or ambiguous.
9. Centralised Content Strategy | Milestones
STE is easily customised and applied to any other industry, including machinery,
automotive, electronics, IT and medical equipment
1970
The US Federal Government
introduced Plain English for
communications with the public.
1982
The European Association of
Aerospace (AECMA) develops
Simplified English for aircraft
maintenance documentation.
2004
AECMA is renamed ASD,
Simplified English becomes
Simplified Technical English.
(ASD-STE100)
October 2006
May 2021
Release of Issue 8.
1970 1982 2004 2006 2021
60% of STE users come
from outside of the
aerospace and defence
sector.
10. Cross-industry business case studies
STE lets you write clear and translatable documentation for a global audience
Oil and gas Heavy machinery Medical diagnostics SaaS
Copyright ยฉ 2023 Shufrans TechDocs @STE_trainer, Shumin Chen
11. Cross-industry business case studies
STE lets you write clear and translatable documentation for a global audience
Information
management
An intelligent information
management platform
that helps companies
make smart connections
across the business and
automate critical
business processes.
TO CREATE NEW ANNOTATIONS TO A DOCUMENT:
1. SELECT A DOCUMENT IN THE CORRECT FORMAT.
2. MAKE SURE THE PREVIEW TAB IS SELECTED IN THE RIGHT PANE.
3. SELECT THE NEW ANNOTATIONS COMMAND FROM THE TASK AREA.
THIS CREATES A NEW ANNOTATION OBJECT BELOW YOUR DOCUMENT IN THE LISTING VIEW, AND
OPENS THE ANNOTATION TOOLBAR IN THE PREVIEW WINDOW.
To start creating new annotations to a document:
1. Select a document in suitable format (for instance, a DOC or PDF).
2. Make sure the Preview tab (not, for example, the Metadata tab) is selected in the
right pane.
3. Select the New Annotations command via the task area on the left-hand side of the
user interface.
This should create a new Annotation object under your document, visible via the listing
view, and open the annotation toolbar in the preview window.
@STE_trainer, Shumin Chen
Copyright ยฉ 2023 Shufrans TechDocs
12. Cross-industry business case studies
STE lets you write clear and translatable documentation for a global audience
Information
management
An intelligent information
management platform
that helps companies
make smart connections
across the business and
automate critical
business processes.
NOTE: THE TASK AREA SHOWS THE NEW ANNOTATIONS OPTION ONLY FOR
DOCUMENTS THAT DO NOT HAVE ANNOTATIONS. IF YOU WANT TO CREATE A
NEW ANNOTATION OBJECT, PRESS THE ALT KEY AND SELECT CREATE >
ANNOTATION. IT IS RECOMMENDED TO ONLY HAVE ONE ANNOTATION OBJECT
FOR EACH DOCUMENT.
Note: The task area displays the New Annotations option only for
documents that do not yet have any annotations. If you want to create
another annotation object, you can do so by pressing the Alt key and
selecting Create > Annotation... from the menu. It is, however,
recommended to have only one annotation object for each document.
@STE_trainer, Shumin Chen
Copyright ยฉ 2023 Shufrans TechDocs
13. Copyright ยฉ 2024 by Shufrans TechDocs. All rights reserved. All trademarks acknowledged.
Optimising Maintenance
Reliability
The user interface system enables operators
to compare images between pre/post
maintenance and repairs efficiently, which
increases the comprehensiveness of an
engine inspection. The robot's capability to
rapidly and precisely capture images at
consistent angles and distances facilitates
seamless comparisons as well. Conducting
this visual audit is vital for preservation of
aircraft engine integrity and safety, as well as
prevention of potential legal issues stemming
from maintenance errors.
Optimising Maintenance
Reliability
The user interface system lets operators
compare images before and after
maintenance and repairs quickly. The robot
can take images quickly and correctly at the
same angles and distances. This helps
personnel compare these images easily. This
visual inspection makes sure that the aircraft
engine is safe to operate, and prevents
maintenance errors.
14. Copyright ยฉ 2024 by Shufrans TechDocs. All rights reserved. All trademarks acknowledged.
Optimising Maintenance
Reliability
The user interface system enables operators
to compare images between pre/post
maintenance and repairs efficiently, which
increases the comprehensiveness of an
engine inspection. The robot's capability to
rapidly and precisely capture images at
consistent angles and distances facilitates
seamless comparisons as well. Conducting
this visual audit is vital for preservation of
aircraft engine integrity and safety, as well as
prevention of potential legal issues stemming
from maintenance errors.
HOPE TECHNIK: EIR
Optimising Maintenance
Reliability
The user interface system lets operators
compare images before and after
maintenance and repairs quickly. The robot
can take images quickly and correctly at the
same angles and distances. This helps
personnel compare these images easily. This
visual inspection makes sure that the aircraft
engine is safe to operate, and prevents
maintenance errors.
15. Shipbuilding: Fuel system
24.1
System description
The fuel system has these functions:
โ Lets personnel fill the fuel tanks from an
external source from shore or a supply
ship.
โ Supply fuel between tanks.
โ Make sure that the main engines,
generator sets and other optional
equipment consumers have sufficient
filtered fuel.
The fuel system has these primary components:
โ Fuel tanks
โ Fuel transfer manifold
โ Fuel cargo pump
โ Fuel separator
โ Fuel transfer pump
โ Water separators
โ Duplex fuel filters
โ Fuel injection pump
โ Bunker filling alarm boxes.
24.1
System description
The fuel system has these functions:
โ Enable the filling of the fuel tanks from an
outside source (from shore or from a
supply ship).
โ Transfer fuel between tanks.
โ Provide consumers such as the main
engines, generator sets and/or other
optional equipment with sufficient filtered
fuel.
The fuel system has these primary components:
โ The fuel tanks
โ The fuel transfer manifold
โ The fuel cargo pump
โ The fuel separator
โ The fuel transfer pump
โ The water separators
โ The duplex fuel filters
โ The fuel injection pump
โ The bunker filling alarm boxes
Copyright ยฉ 2023 by Shufrans TechDocs. All rights reserved. All trademarks acknowledged.
16. Shipbuilding: Fuel system
24.2.1
Fuel tanks
There are three types of fuel tanks:
โ The storage tanks
โ The service tanks
โ The header tanks, also known as day tank.
The fuel storage tanks are used to keep non-purified
fuel in storage.
The header tanks are used to keep purified fuel and
supply fuel for the consumers.
The storage tanks supply fuel to the service tanks.
The fuel separator gets fuel from the service tanks,
treats the fuel and supplies fuel to the header tanks.
When an emergency occurs, you can close the tanks
with the Safety locker on the main deck.
The table shows the fuel tank capacity.
Note:
In some documents, fuel storage tanks are known as
cargo tanks which show their primary function. ๐คท๐ปโ๏ธ
24.2.1
Fuel tanks
There are three types of fuel tanks:
โ The storage tanks
โ The service tanks
โ The header tanks, also called day tank.
The fuel storage tanks are used to store non-purified
fuel.
The header tanks are used to store purified fuel and
supply fuel to the consumers.
The service tanks receive fuel transferred from the
storage tanks. The fuel separator draws fuel from the
service tanks, treats the fuel and transfers to the
header tanks.
When an emergency occurs, the tanks can be closed
remotely from the Safety locker on the main deck.
The table gives an overview of the fuel tank capacity.
Note:
In some documentation the fuel storage tanks might be
referred to as cargo tanks, which reflects their original
function.
Copyright ยฉ 2023 by Shufrans TechDocs. All rights reserved. All trademarks acknowledged.
17. What qualifies as sustainable content?
โ A strong and positive
impact
โ Substantial cost savings in
human & machine
translations
โ Efficient content
management, re-use, and
ultimately self-driven
workflow processes.
@STE_trainer, Shumin Chen
18. Text volume โ 20%*
Translation costs โ 30โ40%
Unique terms โ 50โ70%
*Case study example is based on a manufacturer of mobile X-ray based imaging solutions that created an operator
manual and a service manual in Standard English to be translated into seven other languages.
19. The most dangerous phrase in our language is,
โWe've always done it this way.โ
โRear Admiral Grace Hopper
@STE_trainer, Shumin Chen
20. Software: Data protection & cybersecurity
Acronis develops on-
premises and cloud
software with unique
integration of backup,
disaster recovery,
cybersecurity, and endpoint
management.
Acronis Backup & Recovery 11 for
Microsoft Exchange Server provides
protection for the clustered data
regardless of its placement within the
cluster. This means that even if the
data being backed up changes its
location within the cluster (for
example, if mailbox role is moved to
another server due to a switchover or
a failover), the software will track all
relocations of this data and safely
back it up.
Cluster-wide protection is useful in
the event some of the cluster nodes
go offline, unless the backed up data
becomes completely unavailable, or
backup plan configuration explicitly
prohibits the protection to run on the
remaining nodes (if you select to back
up only the selected node, for
example).
Copyright ยฉ 2023 by Shufrans TechDocs. All rights reserved. All trademarks acknowledged.
21. Software: Data protection & cybersecurity
Acronis Backup & Recovery 11 for
Microsoft Exchange Server
provides protection for the clustered
data๐regardless of its placement
within the cluster. ๐This means that
even if the data being backed up
changes its location within the
cluster (for example, if mailbox
role is moved to another server
due to a switchover or a failover),
the software will track all
relocations of this data and safely
back it up.
Cluster-wide protection is useful ๐คทin
the event some of the cluster nodes
go offline,โunless the backed up
data becomes completely
unavailable, or backup plan
configuration explicitly prohibits the
protection to run on the remaining
nodes (if you select to back up only
the selected node, for example).
The software gives protection for all
clustered data, also if the data ๐
changes its location in the cluster. ๐
For example, if the mailbox role
moves to a different server. The
software records all relocations of
this data and creates a correct
backup.
Cluster-wide protection is useful ๐๐ฝ
when some of the cluster nodes go
offline and the backup data is
available.
โ Cluster-wide protection is not
useful when configuration does not let
the protection operate on the other
nodes. For example, if you only make
a backup of the selected node.
Copyright ยฉ 2023 by Shufrans TechDocs. All rights reserved. All trademarks acknowledged.
22. Send us a one-page document
today and we will evaluate and
rewrite this for you into STE.*
๐ง Mail to: shumin@asd-
ste100.net
*This offer is valid only for technical companies, not
for agencies. Files should be sent from a corporate
e-mail account. Your data will remain confidential
and will not be shared with third parties. Shufrans
TechDocs reserves the right to decline the evaluation
at its discretion.
โLanguage for all
industries..
23. The Future starts now โถ๏ธ ๐ง๐ป๐ป๐ฉ๐ผ
๐ป๐จ๐ฝ๐ป
Customised learning (online & on-site) with real-time
interaction is a popular choice of professional upskilling for
individual technical writers or remote teams who want to
work on their business objectives together.
Project Management Office (PMO)
@STE_trainer, Shumin Chen
24. Q&A
We are what we repeatedly
do. Excellence is not an act,
but a habit.
WILL DURANT ๐ฅ
@STE_trainer, Shumin Chen
Editor's Notes
๐ฃ This is Slido interaction slide, please don't delete it.โ Click on 'Present with Slido' and the poll will launch automatically when you get to this slide.
๐ฃ This is Slido interaction slide, please don't delete it.โ Click on 'Present with Slido' and the poll will launch automatically when you get to this slide.
๐ฃ This is Slido interaction slide, please don't delete it.โ Click on 'Present with Slido' and the poll will launch automatically when you get to this slide.