sgds-writing

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

SGDS Writing Guide

SGDS写作指南

Content standards for government digital products built with the Singapore Government Design System. Apply these rules to all UI copy, documentation, tooltips, labels, error messages, and any written content that accompanies SGDS components.

基于新加坡政府设计系统构建的政府数字化产品内容规范。请将这些规则应用于所有UI文案、文档、工具提示、标签、错误提示以及所有SGDS组件相关的书面内容。

Tone and voice

语气与语态

Write as a trusted, competent partner — not as a bureaucracy. GovTech's voice is:

Clear — say exactly what you mean in as few words as needed
Direct — address the reader as "you"; use active voice
Respectful — treat readers as capable adults; do not over-explain
Purposeful — every sentence earns its place; remove filler

Avoid corporate jargon ("leverage", "synergise", "holistic approach"), hollow intensifiers ("very", "extremely", "crucial"), and vague forward-looking language ("innovative", "cutting-edge", "future-proof") unless the context genuinely calls for them.

Preferred: We help agencies share data securely. Avoid: We leverage cutting-edge, innovative solutions to holistically enable seamless data exchange across government agencies.

以值得信赖、专业可靠的伙伴身份写作，而非官僚机构的口吻。GovTech的行文风格是：

清晰 —— 用最少的文字准确表达你的意思
直接 —— 以“你”称呼读者；使用主动语态
尊重 —— 将读者视为有能力的成年人；无需过度解释
有目的性 —— 每一句话都有存在的意义；删除冗余内容

避免使用企业行话（如“leverage”“synergise”“holistic approach”）、空洞的强调词（如“very”“extremely”“crucial”）以及模糊的前瞻性表述（如“innovative”“cutting-edge”“future-proof”），除非上下文确实需要。

推荐表述： 我们协助各机构安全共享数据。 避免表述： 我们利用前沿创新解决方案，全面实现跨政府机构的无缝数据交换。

Spelling

拼写

Use UK English spelling throughout.

UK (correct)	US (avoid)
colour	color
centre	center
programme	program (unless referring to software)
organisation	organization
recognise	recognize
analyse	analyze
catalogue	catalog
licence (noun)	license (noun)
license (verb)	licence (verb)
travelled	traveled
fulfil	fulfill
practise (verb)	practice (verb)
practice (noun)	practise (noun)

Spell-check setting: set your editor and CI spell checker to
en-GB
. In VS Code, set
"editor.language": "en-GB"
or use the Spell Right extension with
"spellright.language": ["en-GB"]
.

See → reference/spelling.md for a full word list.

全程使用英式英语拼写。

英式（正确）	美式（避免）
colour	color
centre	center
programme	program（指代软件时除外）
organisation	organization
recognise	recognize
analyse	analyze
catalogue	catalog
licence（名词）	license（名词）
license（动词）	licence（动词）
travelled	traveled
fulfil	fulfill
practise（动词）	practice（动词）
practice（名词）	practise（名词）

拼写检查设置：将编辑器和CI拼写检查器设置为
en-GB
。在VS Code中，设置
"editor.language": "en-GB"
，或使用Spell Right扩展并配置
"spellright.language": ["en-GB"]
。

完整词汇列表请查看→ reference/spelling.md。

Capitalisation

大小写规则

Use sentence case for all headings, labels, button text, navigation items, error messages, and body copy — unless a rule below explicitly overrides it.

Sentence case means: capitalise the first word and proper nouns only.

Correct:

Submit your application
View all services
Error: file size exceeds the limit

Incorrect (title case):

Submit Your Application
View All Services
Error: File Size Exceeds the Limit

所有标题、标签、按钮文本、导航项、错误提示和正文均使用句首大写——除非以下规则明确覆盖此要求。

句首大写指：仅首单词和专有名词大写。

正确示例：

Submit your application
View all services
Error: file size exceeds the limit

错误示例（标题大小写）：

Submit Your Application
View All Services
Error: File Size Exceeds the Limit

Exceptions where capitalisation is required

需要大写的例外情况

Proper nouns: GovTech, SingPass, CorpPass, Smart Nation, Singapore, Ministry of Finance
Acronyms that are always written in capitals: API, ICT, UI, UX, PDF, URL
Product and system names that have an established capitalisation: Singpass, CorpPass, MyInfo
The word "I" when used as a pronoun

专有名词：GovTech、SingPass、CorpPass、Smart Nation、Singapore、Ministry of Finance
始终大写的缩写词：API、ICT、UI、UX、PDF、URL
已有固定大小写规范的产品和系统名称：Singpass、CorpPass、MyInfo
用作代词的“I”

Do not capitalise

无需大写的情况

Job titles used descriptively: "the director approved the request" (capitalise only when used as a title directly before a name: "Director Jane Tan approved the request")
Government services or programmes used generically: "the digital identity programme", "the data-sharing initiative"
Seasons, directions, or concepts: "the autumn release", "head north on the main road"

描述性使用的职位头衔："the director approved the request"（仅当头衔直接用于姓名前时大写："Director Jane Tan approved the request"）
泛指的政府服务或项目："the digital identity programme"、"the data-sharing initiative"
季节、方向或概念："the autumn release"、"head north on the main road"

Punctuation

标点符号

No em dash

禁止使用破折号（em dash）

Do not use the em dash (—) under any circumstances. It creates visual noise and is often misread or skipped by screen readers.

Alternatives:

Instead of	Use
The form — which is required — must be submitted by Friday.	The form, which is required, must be submitted by Friday.
Submit before Friday — or your application will lapse.	Submit before Friday. Otherwise, your application will lapse.
Three options — email, phone, or in person — are available.	Three options are available: email, phone, or in person.

Use a colon, comma pair, or a new sentence. Never an em dash.

任何情况下都不得使用破折号（—）。它会造成视觉干扰，且常被屏幕阅读器误读或跳过。

替代方案：

原表述	替代表述
The form — which is required — must be submitted by Friday.	The form, which is required, must be submitted by Friday.
Submit before Friday — or your application will lapse.	Submit before Friday. Otherwise, your application will lapse.
Three options — email, phone, or in person — are available.	Three options are available: email, phone, or in person.

使用冒号、成对逗号或新句子。绝对不要使用破折号。

Commas

逗号

Use the Oxford comma (serial comma) in lists of three or more items.

Correct: You will need your NRIC, passport, and proof of address. Incorrect: You will need your NRIC, passport and proof of address.

在包含三个或更多项目的列表中使用牛津逗号（序列逗号）。

正确示例： You will need your NRIC, passport, and proof of address. 错误示例： You will need your NRIC, passport and proof of address.

Hyphens and en dashes

连字符和短破折号（en dash）

Use a hyphen (-) for compound modifiers before a noun: "user-friendly interface", "end-to-end encryption"
Use an en dash (–) only for number ranges: "pages 10–15", "2020–2024"
Do not use an en dash as a substitute for an em dash

在名词前的复合修饰语中使用连字符（-）："user-friendly interface"、"end-to-end encryption"
仅在表示数字范围时使用短破折号（–）："pages 10–15"、"2020–2024"
不要用短破折号替代破折号

Apostrophes

撇号

Use for possessives: the agency's portal, the user's profile
Do not use for plurals: APIs not API's, PDFs not PDF's

用于所有格：the agency's portal、the user's profile
不要用于复数形式：APIs 而非 API's、PDFs 而非 PDF's

Colons and semicolons

冒号和分号

Colons introduce lists or explanations. Do not capitalise the word after a colon unless it is a proper noun or the start of a full sentence that stands alone.
Use semicolons sparingly. Prefer two short sentences over a semicolded compound sentence.

冒号用于引出列表或解释内容。除非后面是专有名词或独立完整的句子，否则冒号后的单词无需大写。
尽量少用分号。优先使用两个短句，而非带分号的复合句。

Grammar

语法

Active voice

主动语态

Prefer active voice. The subject acts; it is not acted upon.

Active: The system sends a confirmation email. Passive: A confirmation email is sent by the system.

Passive voice is acceptable when the actor is unknown, irrelevant, or less important than the action: "Your data is encrypted at rest."

优先使用主动语态。主语执行动作，而非被动作影响。

主动语态： The system sends a confirmation email. 被动语态： A confirmation email is sent by the system.

当动作执行者未知、无关紧要或不如动作本身重要时，可使用被动语态："Your data is encrypted at rest."

No contrastive negation

避免对比否定

Do not use contrastive negation — the pattern "not X, but Y" or "not only X but also Y". It adds a negation step that slows reading.

Avoid:

Not a bug tracker, but a full project management tool.
This is not optional, but mandatory.
We do not just build tools — we build trust.

Preferred:

A full project management tool that also tracks bugs.
This is mandatory.
We build tools that earn trust.

不要使用对比否定——即“not X, but Y”或“not only X but also Y”的句式。这种结构会增加否定步骤，拖慢阅读速度。

避免表述：

Not a bug tracker, but a full project management tool.
This is not optional, but mandatory.
We do not just build tools — we build trust.

推荐表述：

A full project management tool that also tracks bugs.
This is mandatory.
We build tools that earn trust.

Sentence length

句子长度

Aim for sentences under 20 words. If a sentence needs a clause to clarify another clause, split it into two sentences.

尽量将句子控制在20词以内。如果一个句子需要用从句来解释另一个从句，请拆分为两个句子。

Parallel structure

平行结构

Items in a list, heading pairs, and button labels must follow the same grammatical form.

Correct (all verb phrases):

Create a new account
Reset your password
View your transaction history

Incorrect (mixed forms):

Create a new account
Password reset
Viewing your transaction history

列表中的项目、标题对和按钮标签必须遵循相同的语法形式。

正确示例（均为动词短语）：

Create a new account
Reset your password
View your transaction history

错误示例（混合形式）：

Create a new account
Password reset
Viewing your transaction history

Contractions

缩写形式

Do not use contractions in any content. Write out the full form at all times.

Correct: You do not need to create an account. Incorrect: You don't need to create an account.

Correct: We have updated the interface. Incorrect: We've updated the interface.

Note: This is a deliberate departure from most product design system guides. GOV.UK, Canada.ca, Shopify Polaris, and Apple HIG all recommend using contractions on the grounds that they sound more natural. We avoid them to maintain formal, consistent language appropriate for official Singapore Government products, and to eliminate ambiguity (for example, "it's" vs "its").

任何内容中都不得使用缩写形式。始终写出完整形式。

正确示例： You do not need to create an account. 错误示例： You don't need to create an account.

正确示例： We have updated the interface. 错误示例： We've updated the interface.

注意： 这是与大多数产品设计系统指南的刻意区别。GOV.UK、Canada.ca、Shopify Polaris和Apple HIG都建议使用缩写形式，认为其听起来更自然。我们避免使用缩写是为了保持新加坡政府官方产品所需的正式、一致的语言风格，并消除歧义（例如“it's”与“its”的区别）。

Modal verbs — must, need to, should, may

情态动词——must、need to、should、may

Use modal verbs precisely. The wrong choice creates unintended legal obligations or false reassurances.

Word	When to use	Example
Must	Legal obligation — the user has no choice	You must submit the form by 31 January.
Need to	An administrative step the user is expected to complete	You need to verify your email before signing in.
Should	A recommendation — the user is advised but not obligated	You should save your progress regularly.
May	Permitted but optional	You may attach supporting documents.

Do not use "must" for administrative steps — it implies a legal consequence that may not exist. Do not use "should" when the step is actually required.

精准使用情态动词。错误的选择会产生意外的法律义务或虚假承诺。

词汇	使用场景	示例
Must	法律义务——用户别无选择	You must submit the form by 31 January.
Need to	用户需完成的行政步骤	You need to verify your email before signing in.
Should	建议——用户被建议但无义务	You should save your progress regularly.
May	允许但可选	You may attach supporting documents.

不要将“must”用于行政步骤——这暗示了可能不存在的法律后果。当步骤确实是必填项时，不要使用“should”。

Numbers

数字

Spell out numbers one to nine; use numerals for 10 and above.
Always use numerals for: percentages (5%), currency ($10), measurements (3 MB), and version numbers (version 2).
Use commas in numbers of 1,000 or more: 1,000 not 1000.
Use numerals for ranges even if both numbers are below 10: "3–9 working days".

1到9的数字拼写出来；10及以上使用阿拉伯数字。
以下情况始终使用阿拉伯数字：百分比（5%）、货币（$10）、度量单位（3 MB）和版本号（version 2）。
1000及以上的数字使用逗号分隔：1,000 而非 1000。
即使两个数字都小于10，范围数字也使用阿拉伯数字："3–9 working days"。

Dates and times

日期与时间

Dates: 1 January 2025 (day month year, no ordinal suffixes — not "1st January")
Times: 9am, 3:30pm (no space between number and am/pm)
Date ranges in prose: 1 to 3 January 2025 (write "to", not an en dash)
Date ranges in tables and compact UI elements: 1–3 Jan 2025 (en dash is acceptable where space is limited)

日期：1 January 2025（日月年，无序数后缀——不要写成"1st January"）
时间：9am、3:30pm（数字与am/pm之间无空格）
散文中的日期范围：1 to 3 January 2025（用“to”而非短破折号）
表格和紧凑UI元素中的日期范围：1–3 Jan 2025（空间有限时可使用短破折号）

Plain language principles

简明语言原则

Lead with the most important information. Put the key point in the first sentence.
One idea per paragraph. If a paragraph covers two ideas, split it.
Cut filler. Remove "please note that", "it should be noted", "in order to", "at this point in time".
Prefer short words. Use "use" not "utilise", "help" not "facilitate", "buy" not "procure", "show" not "demonstrate".
Avoid nominalisations. Change "make a decision" to "decide"; "provide assistance" to "help"; "conduct an investigation" to "investigate".
Do not use "please" in instructions. It adds no information and reads as hedging. Write "Submit the form" not "Please submit the form". The exception is expressions of genuine courtesy in transactional emails or formal correspondence.
Do not use subjective adjectives. Do not tell users that something is "important", "easy", "simple", "quick", or "exciting". If it is important, show why. If it is simple, let the design demonstrate that. Subjective claims that cannot be verified erode trust.

优先呈现最重要的信息。将核心要点放在第一句。
每段一个核心观点。如果一段包含两个观点，请拆分段落。
删除冗余内容。移除“please note that”“it should be noted”“in order to”“at this point in time”等表述。
优先使用短词。用“use”而非“utilise”，“help”而非“facilitate”，“buy”而非“procure”，“show”而非“demonstrate”。
避免名词化结构。将“make a decision”改为“decide”；“provide assistance”改为“help”；“conduct an investigation”改为“investigate”。
说明性内容中不要使用“please”。它没有实际信息，读起来显得犹豫不决。写“Submit the form”而非“Please submit the form”。例外情况是事务性邮件或正式信函中表达真正的礼貌。
不要使用主观形容词。不要告诉用户某事“important”“easy”“simple”“quick”或“exciting”。如果重要，请说明原因。如果简单，让设计来证明。无法验证的主观主张会削弱信任。

UI copy patterns

UI文案模式

Buttons and calls to action

按钮与行动号召

Use verb phrases: "Submit form", "Download report", "Sign in"
Do not use vague labels: "Click here", "OK", "Go"
Do not add punctuation to button labels

使用动词短语："Submit form"、"Download report"、"Sign in"
不要使用模糊标签："Click here"、"OK"、"Go"
按钮标签不要添加标点符号

Error messages

错误提示

State what happened and what the user should do next.
Do not blame the user.

Correct: The file is too large. Upload a file under 5 MB. Incorrect: You uploaded a file that is too large. Please upload a smaller file.

说明发生了什么以及用户接下来应该怎么做。
不要指责用户。

正确示例： The file is too large. Upload a file under 5 MB. 错误示例： You uploaded a file that is too large. Please upload a smaller file.

Empty states

空状态

Explain why the space is empty and offer a next step.

Correct: No applications yet. Start your first application. Incorrect: Nothing here.

说明空间为空的原因并提供下一步操作。

正确示例： No applications yet. Start your first application. 错误示例： Nothing here.

Tooltips and helper text

工具提示与辅助文本

Keep tooltips to one sentence.
Helper text below a field explains the format or constraint, not a restatement of the label.

Label: Date of birth Helper text: Use DD/MM/YYYY format Not: Enter your date of birth in DD/MM/YYYY format

工具提示控制在一句话以内。
字段下方的辅助文本说明格式或限制，而非重复标签内容。

标签： Date of birth 辅助文本： Use DD/MM/YYYY format 错误示例： Enter your date of birth in DD/MM/YYYY format

Loading and status messages

加载与状态提示

Use present progressive: "Loading your results…", "Saving changes…"
Confirm success with past tense: "Changes saved.", "Application submitted."

使用现在进行时："Loading your results…"、"Saving changes…"
用过去时确认成功："Changes saved."、"Application submitted."

Accessibility considerations

无障碍设计注意事项

Do not rely on colour alone to convey meaning — always pair colour with text.
Alt text for images should describe function, not appearance: "GovTech logo" not "blue rectangular image with text".
Link text must make sense out of context: "Download the annual report (PDF, 2 MB)" not "click here".
Avoid directional instructions that rely on visual layout: "see the section on the right" does not work for screen-reader users.

不要仅依赖颜色传达含义——始终搭配文字说明。
图片的替代文本应描述功能而非外观："GovTech logo" 而非 "blue rectangular image with text"。
链接文本脱离上下文时仍应表意清晰："Download the annual report (PDF, 2 MB)" 而非 "click here"。
避免依赖视觉布局的方向性说明："see the section on the right" 对屏幕阅读器用户无效。

Reference files

参考文件

Topic	File
UK vs US spelling word list	→ reference/spelling.md
Grammar rules quick reference	→ reference/grammar.md
Punctuation quick reference	→ reference/punctuation.md
Word choice and plain language	→ reference/word-choice.md

主题	文件
英式vs美式拼写词汇列表	→ reference/spelling.md
语法规则速查	→ reference/grammar.md
标点符号速查	→ reference/punctuation.md
词汇选择与简明语言	→ reference/word-choice.md