Zcash in Simplified Technical English

Writing rules

These rules apply to each page on this site. The source of the rules is ASD-STE100, Simplified Technical English (STE). A checker program, check.py, examines each page against the rules that a program can measure.

1. Meaning

2. Content that stays the same

Copy these items from the source with no changes:

3. Words

Replacement words

The checker rejects the words in the left column.

Source wordSTE word
allow, enable, permitlet
ensure, guarantee thatmake sure
perform, carry outdo
providegive, supply
require, need (verb)must, necessary
obtain, acquireget
utilizeuse
whetherif
which (relative pronoun)that
howeverbut
therefore, hencethus
prior tobefore
in order toto
e.g., i.e., etc.for example, that is, and other items
might, could, wouldcan, or a statement in the simple present tense

4. Sentences

The checker counts words as follows. A mathematical expression is one word. A code item is one word. A sentence ends at a colon. Text in parentheses is a different sentence.

5. BCP 14 key words

The key words of BCP 14 are in the source documents. Only some of these words are approved in STE. The STE replacements are in this table.

Source key wordSTE text
MUST, SHALL, REQUIREDmust
MUST NOT, SHALL NOTmust not
SHOULD, RECOMMENDEDwe recommend that …
SHOULD NOT, NOT RECOMMENDEDwe recommend that … not …
MAYcan
OPTIONALoptional

6. Term list

The writers add terms to this list as they write more STE versions.

Term to useSource words
expiry heightexpiration time, expiration block height, expiry
block heightblockheight, height of the block
transactiontx, txn
target block spacingblock target spacing, target spacing, target block time
network upgradeupgrade, hard fork (when it means a planned upgrade)
activation heightactivation block height, activation blockheight
implementationsoftware, client (when it means node or wallet software)
conventional transaction feeconventional fee, standard transaction fee
unpaid actionunpaid logical action
adversaryattacker
block chainblockchain
pull requestPR
ZIP draftdraft, proposal (when it means a ZIP that has no number)
OwnersZIP Owners, authors (when it means the current owners of a ZIP)
ZIP EditorsEditors
calculatecompute
selectpick, choose
increase, decreaseraise, reduce, cut
changemodify, alter
sendsubmit
refer tosee
a maximum of, a minimum ofup to, at least (for quantities)
usuallynormally, typically
have an effect onaffect, impact
startbegin, commence
at this timecurrently
latersubsequent
previouspreceding
approximatelyroughly, about
applicableappropriate, relevant
differentdistinct (when the meaning stays the same)
keepretain, maintain
greater thanexceed
this ZIPthis proposal (for a ZIP that has a number)
create (a transaction)construct
inbound connectionincoming connection

7. Limits of this version