Bay Six Software Forum Index Bay Six Software
Beyond the Basics
 
 FAQFAQ   SearchSearch   UsergroupsUsergroups   RegisterRegister 
 ProfileProfile   Log in to check your private messagesLog in to check your private messages   Log inLog in 

Simplified Technical English

 
Post new topic   Reply to topic    Bay Six Software Forum Index -> ViviFire language -> ViviFire Documentation
View previous topic :: View next topic  
Author Message
Brent
Site Admin


Joined: 01 Jul 2005
Posts: 800
PostPosted: Mar 31st, 2017, 12:43am    Post subject: Simplified Technical English Reply with quote
I am in the process of changing how I write the documentation. After reading about Simplified Technical English (STE), which is used in the aerospace industry and a few other places, I am attempting to simplify my writing so that non-native English speakers can understand it better. If you are interested in the subject, you can download a PDF document that explains the process. It includes two lists: words that are allowed, and words that are not allowed, along with substitutes for the latter.

If you want an example, here's a section from the Character and String Equates article.
Quote:
A character equate makes the use of non-printable characters more readable. You can use one where you would use a code point, a number specified by a character set.
A character equate is a single token made of two parts. The first character is the percent sign ("%"). The remaining characters are letters ("A" through "Z"). The letters can be all upper case, lower case, or mixed case.
A table of all recognized character equates follows.

_________________
Brent
Back to top
View user's profile Send private message Send e-mail
Display posts from previous:   
Post new topic   Reply to topic    Bay Six Software Forum Index -> ViviFire language -> ViviFire Documentation All times are GMT
Page 1 of 1
Jump to:  
Quick Reply
Username:
Message:
   Shortcut keys: Alt+Q to activate, Alt+P to preview, Alt+S to submit
You can post new topics in this forum
You can reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum
You cannot attach files in this forum
You can download files in this forum



Lo-Fi Version
Powered by phpBB © 2001, 2005 phpBB Group