书写建议

句式分类

纯文本说明

建议使用常规主谓宾语序对事物进行清晰表述.

推荐不推荐
SSD机型适用于对数据库性能要求较高的业务场景。数据库性能要求较高的业务场景,SSD机型是适用的。

告警/报错

建议使用祈使语句,省略不必要的解释说明,优先提供纠错方案及引导.

推荐不推荐
请输入管理员密码管理员密码的输入不能为空,请输入

操作反馈

建议简短阐述结果并给到必要的下一步操作引导,如有跳转建议添加.

推荐不推荐
支付失败。你的账户余额不足,请 充值 重新购买。因为您的账户余额不足,所以无法支付。您可以先去充值后再来购买。

优先短句及短语

简单逻辑下,关注效率。短句或短语相比于语法准确的长句更易突出重点以便读者理解.

推荐不推荐
切换至 VNC登录如需使用VNC方式访问主机,请点击这里

标点符号

去除非必要标点符号

部分组件文案可以省略标点符号(标签、按钮、冒泡提示、输入组件提示及报错)

null

谨慎使用感叹号

感叹号用于表达强烈情感,不当的使用会给用户造成情绪化的印象,同时会减弱内容专业感、可信度。因此,2B平台不推荐广泛使用感叹号。

推荐不推荐
你的资源即将到期,请尽快续费。你的资源即将到期,请尽快续费!

善用有序/无需列表

善用有序/无序列表阐述复杂内容可以使表达更加简洁、清晰。这里需要注意的是,序列号后的标点要使用实心句号 ”.”,不要使用逗号“、”

推荐不推荐
1.内容…1、内容…

数字、时间及货币单位

量词、数值、百分比

建议使用数字而非中文,数字前后增加空格。短语或常用词汇中包含数字,可保留使用中文。eg. 第一次、三叶草

相对时间、绝对时间

  • 相对时间:适用于无需具体时间点的场景。

    • 时间选择组件的快捷选项:1小时、6小时、12小时、1天、自定义
    • 模糊时间点表述(如,文档中心评论功能的历史评论)
    时间长度显示
    1分钟内刚刚
    1分钟<T<1小时T分钟前
    1小时<T<24小时T小时前
    24小时<T1天前/3天前/7天前/1个月前/3个月前/6个月前/T个月前
    5年<T绝对时间:YYYY-MM-DD HH:MM:SS
  • 绝对时间:适用于需要展示精确时间点的场景,如创建时间、监控时间等。

    分类显示
    时间点YYYY-MM-DD HH:MM:SS
    时间范围YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS

金额

​ 涉及消费的服务平台常需要向用户展示各种金额信息。其中,常见的金额显示主要集中在购买页面、订单页面、账单页面、账户信息页面等。因为这些流程涉及很多支付、对账等特定业务场景,而这些场景与线下的日常生活又息息相关。因此,这部分信息的展示还需要遵循银行服务业的金额显示规范。

  • 列表内金额居左对齐

  • 合理使用单位换算及科学计数法,数字达5位及以上,单位需改为“万”、“亿”

    推荐不推荐
    4.01万元40,010.00 元、四万零壹十元
  • 小数点后有效保留2位

  • 阿拉伯数字与汉字一起使用,数字前后空一格

    推荐不推荐
    已读 30 条已读30条
    待支付金额 30.00 元待支付金额30.00元
  • 金额进出显示规则:基于不同主体和场景,正数为入账,负数为出账 | 情况描述 | 正数 | 负数 | | ------------------------------------------ | ---- | -------- | | 购买、订单信息、账户流水(主体为用户账户) | 消费 | 退费 | | 删除资源、变更配置(主体为原消费记录) | 退费 | 应补差价 |

数据及脱敏

涉及用户隐私信息的数据显示,需要进行脱敏处理以避免泄漏。通常显示的隐私数据及脱敏规则如下:

数据类别显示范例
手机号码 / 座机号码+86 132**4091 / 025-5**646
支付卡号************8460
密钥mongodb://root:****@10.9.113.215:27017,10.9.23.243:27017,10.9.82.123:27017/?replicaSet=umongodb-rs-9wnemyjv7en
邮箱*******@163.com

中西文混排

基于内容所在语境选用中/英文标点

推荐不推荐
在UCloud云主机上,无需外网IP地址即可获取所需的Python Package。在UCloud云主机上,无需外网IP地址即可获取所需的Python Package.

避免使用缩写,正确使用大小写

推荐不推荐
你可以使用 JavaScript 或者 HTML5 框架进行前台开发。你可以使用 js 或者 h5 框架进行前台开发。

中文语境内的英文前后需增加空格(英文与中文标点间无需空格)

推荐不推荐
Steve Jobs 那句话是怎么说的?「Stay hungry,stay foolish.」Steve Jobs 那句话是怎么说的?「 Stay hungry ,stay foolish .」

英文语境中,冠词、介词、并列连词无需大写首字母

推荐不推荐
Type and FeatureType And Feature

相关文档

Copyright © 2021-2024 UCloud 优刻得科技股份有限公司