Skip to content
Logo

Style and Terminology

SEAL/Initiative

Authored by:

matta
matta
The Red Guild | SEAL

🔑 Key Takeaway: Write direct American English with explicit subjects, defined acronyms, and must / should / may modality. Prefer the canonical terms below over local variants.

This page is the canonical editorial standard for wording and terminology. Structure and page types live in the content model. Contributor workflow lives in the contributing guide.

Voice and wording

  • American English spelling and punctuation
  • Objective, explanatory, technical tone; do not oversimplify into slogans
  • No first person for recommendations (Implement X, not I suggest X or We recommend X)
  • Prefer present tense for enduring guidance; past tense for historical incidents
  • Active voice when the actor matters (Signers verify the raw transaction)
  • Concrete subjects: teams, operators, signers, maintainers, responders, stewards
  • Non-technical orientation before technical depth on every educational page
  • Introduce each acronym on first use: multi-factor authentication (MFA)
  • Prefer future-proof wording over product-version trivia unless a page is a product guide
  • Grammar assistance tools are fine; submitting wholly AI-generated pages is not
  • Keep paragraphs short; break complex ideas with lists, tables, or diagrams
  • Sentence length: favor clarity over filler; split stacked clauses when a step or risk appears

What to avoid

  • Conversational asides and hype
  • Unsupported absolute guarantees (bulletproof, unhackable, fully secure)
  • Generic openings that restate the title without stakes
  • “Click here” or bare URLs as link text
  • Mixing British and American spelling in the same framework

Normative modality

Use RFC-style modality in procedures, checklists, and requirements:

TermMeaning
mustRequired for correctness, security of the stated control, compliance with the page’s procedure, or safe operation
shouldDefault recommendation with valid, stated or obvious exceptions
mayOptional or situational

Guidelines:

  • Do not silently upgrade every should to must
  • Prefer must / should / may over “it is recommended that”, “consider doing”, or “where possible” unless the condition is explained in the same sentence
  • When exception conditions matter, write them next to the requirement
  • Descriptive prose (architecture background) does not need modality on every sentence
  • Primary sources beat secondary summaries for incidents, CVEs, standards, and product behavior
  • Historical loss figures and attack attributions need a citation or must be softened/removed
  • Prefer descriptive link text (OWASP ASVS, not this article)
  • Use relative paths for internal links (/wallet-security/overview)
  • Prefer a Further Reading & Tools (or Resources) section for external catalogs; keep in-body citations where the claim appears when that helps verification
  • For important external material, add archived mirrors when available
  • Do not invent citations from model memory

Dead or unstable links: replace, archive, or remove the claim. Do not leave knowingly broken authority links.

Capitalization and names

FormRule
Security AllianceFull organization name
SEALAcronym after first expansion when needed; acceptable in titles with | SEAL
Security FrameworksThis project’s suite
Vault Boy–style product namesUse official capitalization (GitHub, Discord, Cloudflare)
HeadingsSentence case preferred (Signing verification), not Title Case Every Word, unless a proper noun

Canonical terminology

Preferred forms derived from high-quality existing usage in this repository. Use the preferred column unless a quoted API, UI string, or legal name requires another form.

PreferredAvoid / limitNotes
Web3web3, Web 3, WEB3Capital W, no space
blockchainBlockchain (except headings/starts)Common noun
smart contractSmart Contract (mid-sentence)
multisigmulti-sig, multi sig, MultiSigAdjective or noun; expand once if audience is new
multi-factor authentication (MFA)inconsistent 2FA-only language when MFA is meantUse 2FA when the control is exactly two factors
two-factor authentication (2FA)2fa, Two Factor
operational security (OpSec)OPSEC, opsec (prose)OpSec after expansion; folder slug remains opsec
incident responseIncident Response (mid-sentence)Capitalize in formal team names
supply chainsupply-chain (noun)Hyphenate as adjective: supply-chain attack
front end (noun), front-end (adjective)frontend in prosefrontend allowed in code, package names, path slugs
on-chain / off-chainonchain, offchain, on chainHyphenated
allowlist / denylistwhitelist / blacklistExcept historical quotes
walletClient or account UX users sign with
signerParty authorized to approve
accountProtocol or platform account; disambiguate from wallet
key / credential“secret” when key material is meantBe precise
seed phraseseedphrase, mnemonic (unless defining)
private keyprivkey in prose
protocolproject/org when you mean the company or DAODo not call a company a “protocol” casually
team / organization / DAOindistinct “they”Name the actor
Security Alliance / SEALSeal, S.E.A.L.

Product and stack names

Use vendor capitalization: npm, Ethereum, Solana, Bitcoin, EVM, RPC, DNS, DNSSEC, CDN, CI/CD, HSM, hardware wallet brand names per vendor docs.

Path and filename conventions

  • Directories and MDX slugs: kebab-case
  • Framework entry file: overview.mdx (not README.mdx for new pages)
  • No spaces or underscores in new content paths

Examples

Prefer:

Signers must verify the destination, asset, and calldata on a hardware wallet display before approving.

Avoid:

We recommend that you consider verifying transactions where possible so you can be fully secure.

Prefer:

Operational security (OpSec) reduces the chance that sensitive workflows leak to an adversary.

Avoid:

OPSEC is critical in web3 and all teams should basically do it.