博客 (20)

本文记录于 2024 年 11 月。

版本选择原因：

• Discuz! X5 刚刚发布，生态尚未成熟，考虑到是老论坛升级，所以选择 X3.5。

• Discuz! X3.5 目前最高支持 PHP 8.2、MySQL 8.0。

完整升级步骤：

1. 购买新的 ECS、PolarDB，具体环境配置步骤参此文；

2. 安装宝塔面板并配置；

3. 安装 nginx 及 PHP；

4. 创建网站、配置 SSL、伪静态、防盗链、可写目录禁执行、仅允许部分入口文件执行等（.conf）；

5. 配置 hosts；

6. 如果是正式升级阶段，关闭论坛，防止产生新数据。

7. 备份原网站程序、PolarDB 数据库；

8. PolarDB 创建快照。

   测试阶段：从快照还原到新实例（MySQL 5.6 不能直接恢复到 MySQL 8.0），然后从 5.6 迁移到 8.0.x；

   正式阶段：全量模式直接从原实例迁移到 8.0.x，若增量模式且存在触发器，建议从快照还原；
   

9. 上传原网站程序到新的站点目录下；

10. 按 Discuz! X 升级文档升级 X3.4 至 X3.5；详情见下文 ↓；

11. 升级完成后切换到 PHP 8；
    

12. 配置 OSS、Redis、更新缓存等；

13. 测试论坛基本功能是否正常；检查附件是否能够正常上传；检查附件是否正常显示；全面检查控制台配置；

14. 逐个开启插件并检查兼容性（短信通、马甲引擎等）；

15. 按二开备忘录逐个按需进行二开；

16. 逐个修改调用论坛接口的项目及直接调用论坛数据库的项目；

17. 调试 MAGAPP 接口；

18. 尝试强制 https 访问；
    

19. 将以上所有修改后的程序保留备份；发布升级公告并关闭论坛；重复以上步骤；修改域名解析；开启论坛；
    

20. 配置 IP 封禁、定时器、日志、自动备份、配置其它 ECS 的 hosts 等；

21. 查看搜索引擎中收录的地址，是否有无法访问的情况；
    

22. 尝试将历史遗留的本地附件全部转移到 OSS；

23. 建议 在新服上创建 3 个网站：

1. 第 1 个用来尝试迁移、升级、二开，并测试所有功能；

2. 第 2 个用来再次重复这些步骤，最终保留程序代码及 UGC 文件，作为最终的网站程序，以正式域名作为网站根目录路径；

3. 第 3 个用来正式升级，主要功能是升级最新数据库。完成后修改第 2 个网站的数据库连接指向到最新的数据库，差异化同步新增的 UGC 文件到第 2 个网站。

Discuz! X 升级步骤及注意点：

• 因 PolarDB MySQL 不支持压缩，所以应移除 Discuz! 和 UCenter 代码中所有的 MYSQLI_CLIENT_COMPRESS，将 , MYSQLI_CLIENT_COMPRESS 替换为 /*, MYSQLI_CLIENT_COMPRESS*/。

• 升级前务必先修改 ./config/ 目录下的数据库/缓存连接信息，以防出现新站连接老库的情况；

• 按官方文档进行升级，升级前先修改一下：

• 【UC】先升级 UCenter 1.6 至 1.7。

  将 /uc_server/data 权限改为 777 并递归。

  打开 update_ucenter_adult.php 修改 $limit 值为 10000 以免执行超时。

  因通信失败的“发送通知失败”可以直接改 URL 参数跳过就完成了，原因可能是因数据量大，发送改名通知执行改名时超时。等DZ升级完成后UC会自动重试改名通知，或单独写个 php 文件将 UCenter 的用户名同步到应用的数据库。
  

• 【DZ】运行到 /install/update_adult.php?step=innodb&table=pre_common_member_grouppm 时报错：Duplicate key name 'gpmid' ALTER TABLE common_member_grouppm ADD INDEX gpmid(gpmid);

  解决方法：先删除索引，因保存时提示失败，应同时取消 gpmid 字段的自增，转换成功后再设置自增。
  

• 【DZ】运行到 /install/update_adult.php?step=file 一片空白而停止

  正在解决
  

• 【问题】common_menber 表用户名字段编码转换失败

  原因是部分用户名包含特殊字符（如全角空格），用以下语句查看两个表同一 uid 的不同用户：

  SELECT 
      u.uid, 
      u.username AS ucenter_username, 
      c.username AS common_username
  FROM 
      pre_ucenter_members u
  JOIN 
      pre_common_member c ON u.uid = c.uid
  WHERE 
      u.username <> c.username

  Discuz! 用户登录都是以 UCenter 中的用户名为主，所以可以写个小程序直接将 pre_ucenter_members 的用户名同步到 pre_common_member 中，另外 pre_ucenter_members 的用户数少于 pre_common_member 是正常的。若 pre_common_member_archive 表遇到错误同理。

• 如果用户登录慢，或打开 UCenter 慢，是因为 UC 正在通知 DZ 改用户名，每次打开一个页面会更改一个用户名，具体可以查看 pre_ucenter_notelist 中 closed 为 0 的队列，或进入 UC 后台-数据列表-通知列表 查看。

• 【问题】发布主题遇到错误：(1062) Duplicate entry '*' for key 'pid'

  【原因】forum_post 中的 pid 不是自动增长的，而是由表 forum_post_tableid 中自动增长的 pid 生成的。如果生成的 pid 值已在 forum_post 表中存在，则会出现此错误。

• 【解决】迁移数据库时应关闭论坛，以防止 forum_post 表有新数据插入。

• 【问题】打开帖子页面 ./thread-***-1-1.html 显示 404 Not Found，而 ./forum.php?mod=viewthread&tid=*** 可以正常打开

  【原因】未配置伪静态（可在宝塔面板中选择）

• 【问题】打开 UCenter 时报错：UCenter info: MySQL Query Error SQL:SELECT value FROM [Table]vars WHERE name='noteexists'

  【解决】打开文件 ./uc_server/data/config.inc.php 配置数据库连接

• 【问题】打开登录 UCenter 后一片空白

  【解决】将目录 ./uc_server/data/ 设为可写

• 需要将原来安装的插件文件移回 ./source/plugin/ 目录，并设置可写；

• 界面-表情管理，界面-编辑器设置-Discuz!代码

后续 Discuz! X3.5 小版本升级注意事项：

1. 确认插件是否支持新版本（如短信通）

2. 先创建一个新网站测试二开代码

3. 保留 /config/、/data/、/uc_client/data/、/uc_server/data/、/source/plugin/，其它移入 old

4. 上传文件

5. 移回其它需要的文件，如：

6. -- 勋章/loading/logo/nv 等：/static/image/common/

7. -- 表情：/static/image/smiley/

8. -- 水印：/static/image/common/watermark.*

9. -- 风格：/template/default/style/t2/nv.png 等

10. -- 默认头像：/uc_server/images/noavatar_***.gif

11. -- 根目录 favicon.ico 等
    

12. -- 及其它非 DZ 文件

13. 再次检查可写目录的写入权限和禁止运行 PHP 效果。

本文基于 manifest v3

插件使用 Web 技术开发

浏览器提供额外的插件 API

插件与网页分离，运行在一个独立的环境中

插件 API 功能

• 管理 Tabs、窗口、历史记录、书签、Cookies、下载、浏览数据、通知、网站权限

• 管理浏览器的外观和感觉 - 背景、主题、右键菜单、新标签页、启动页面

• 定制 DevTools

• 向网页注入脚本，与网页通信，与系统中的 Native 应用程序通信

• 修改/监听发送的 HTTP 请求/接收的回复

插件构成

* 即便 content script 是注入到网页中的，而且是运行在 Renderer 进程（与主网页相同的进程），但是它们仍运行在不同的世界（world）。主网页运行在 main world，插件的 content script 运行在 isolated world。比如说 main world 中有一个变量，它在 isolated world 中是访问不到的，但是如果修改了 dom，对其它世界是有影响的。

将 Chrome 插件迁移到 Edge

• 移除 Chrome 独有的 API（如调用 Google 账户）

• 移动 update_URL 字段（如果是从 Chrome 商店直接下载的包会有这个字段）

• 改名 Chrome 相关的文字（插件名称、描述文字）
  

参考文献

1. Microsoft Edge 扩展入门（官方）

2. 一小时精通Edge扩展开发Microsoft Edge 文档（视频）
   

本文记录于 2021 年 9 月。

版本选择原因：

• Alibaba Cloud Linux 完全兼容 CentOS，相比于 CentOS 较短的生命周期，Alibaba Cloud Linux 3 将于 2029 年 4 月 30 日结束生命周期。

• Discuz! X3.4 不支持 PHP 8.0，安装时即报错，打开页面时一片空白。

• MySQL 8.0 和阿里云 RDS 的 MySQL 7.5 不支持 MyISAM，而数据表 pre_common_member_grouppm 和 pre_forum_post 使用联合主键且自动递增字段不是第一主键，使用 InnoDB 引擎创建表时会报“1075 - Incorrect table definition; there can be only one auto column and it must be defined as a key”错误，而擅自更改主键次序会影响业务逻辑。因此，在必须选择阿里云 RDS 的情况下，只能选择 MySQL 5.6。（2023年8月注：查看如何更改为 InnoDB）

• Discuz! X3.5 正式版尚未发布（截止发稿），即便发布，插件也可能不能得到及时更新。相比之下，X3.4 首个版本发布距今已有 4 年，相关第三方插件已经非常成熟。

完整升级步骤：

1. 备份原网站程序、RDS 数据库；

2. 购买新的 ECS、RDS，挂载磁盘，安装云监控；

3. 迁移（或还原）数据库到新的 RDS；
   

4. 安装宝塔面板并配置；

5. 安装 nginx 及 PHP；

6. 创建网站、配置 SSL、伪静态、防盗链、可写目录禁执行等（.conf）；

7. 配置 hosts；

8. 上传原网站程序到新的站点目录下；

9. 按 Discuz! X 升级文档升级 X3.2 至 X3.4；详情见下文 ↓；

10. 配置 OSS、Redis、更新缓存等；

11. 测试论坛基本功能是否正常；检查附件是否正常显示；全面检查控制台配置；

12. 逐个开启插件并检查兼容性；

13. 按二开备忘录逐个按需进行二开；

14. 逐个修改调用论坛接口的项目及直接调用论坛数据库的项目；

15. 调试 MAGAPP 接口；

16. 尝试强制 https 访问；
    

17. 将以上所有修改后的程序保留备份；发布升级公告并关闭论坛；重复以上步骤；修改域名解析；开启论坛；
    

18. 配置 IP 封禁、定时器、日志、自动备份、配置其它 ECS 的 hosts 等；

19. 查看搜索引擎中收录的地址，是否有无法访问的情况；
    

20. 尝试将历史遗留的本地附件全部转移到 OSS；

21. 参这篇文章，可能有其它需要配置的地方。
    

Discuz! X 升级步骤及注意点：

• 升级前务必先修改 ./config/ 目录下的数据库/缓存连接信息，以防出现新站连接老库的情况；

• 按官方文档进行升级；
  

• 【问题】运行到 ./install/update.php?step=data&op=notification 时白屏。

  【排查】尝试切换到 PHP 5.6 后成功（但该版本过于陈旧不能使用）；尝试升级 CPU 和内存 PHP 7.4 上升级仍不成功。

  【原因】DB::result_first() 方法不对 SQL 语句追加“limit 1”，而是 SELECT 所有记录后在 PHP 端取第一条数据；

  【解决】打开文件 update.php，查找 elseif($_GET['op'] == 'notification')，该节点的功能是在表 home_notification 中查找 category <= 0 的数据并修复它，如果数据库中所有 category 都大于 0，直接注释其内部 if 代码段继续升级即可（或改为 if(false && ...)）。

• 【问题】发布主题遇到错误：(1062) Duplicate entry '*' for key 'pid'

  【原因】forum_post 中的 pid 不是自动增长的，而是由表 forum_post_tableid 中自动增长的 pid 生成的。如果生成的 pid 值已在 forum_post 表中存在，则会出现此错误。

  【解决】迁移数据库时应关闭论坛，以防止 forum_post 表有新数据插入。

• 【问题】打开帖子页面 ./thread-***-1-1.html 显示 404 Not Found，而 ./forum.php?mod=viewthread&tid=*** 可以正常打开

  【原因】未配置伪静态（可在宝塔面板中选择）

• 【问题】打开 UCenter 时报错：UCenter info: MySQL Query Error SQL:SELECT value FROM [Table]vars WHERE name='noteexists'

  【解决】打开文件 ./uc_server/data/config.inc.php 配置数据库连接

• 【问题】打开登录 UCenter 后一片空白

  【解决】将目录 ./uc_server/data/ 设为可写

• 需要将原来安装的插件文件移回 ./source/plugin/ 目录，并设置可写；

• 界面-表情管理，界面-编辑器设置-Discuz!代码

后续 Discuz! X3.4 R 小版本升级注意事项：

1. 确认插件是否支持新版本（如短信通）

2. 先创建一个新网站测试二开代码

3. 保留 /config/、/data/、/uc_client/data/、/uc_server/data/、/source/plugin/，其它移入 old

4. 上传文件

5. 移回其它需要的文件，如：

6. -- 勋章/loading/logo/nv 等：/static/image/common/

7. -- 表情：/static/image/smiley/

8. -- 水印：/static/image/common/watermark.*

9. -- 风格：/template/default/style/t2/nv.png 等

10. -- 默认头像：/uc_server/images/noavatar_***.gif

11. -- 根目录 favicon.ico 等
    

12. -- 及其它非 DZ 文件

13. 再次检查可写目录的写入权限和禁止运行 PHP 效果。

1075 - Incorrect table definition; there can be only one auto column and it must be defined as a key

在 MyISAM 转 InnoDB 时出现。

原因：这个表有联合主键，且自增的字段不是第一个主键。

解决方法一，取消自增字段的自动递增，改为在程序中实现；

解决方法二，单独给自增字段单独添加一个索引。

以 Disucz! X3.4 为例，方法一改程序代码显然困难比较大，所以选择方法二。

表 pre_forum_post 中，tid 为第1主键，position 为第2主键且自增。

tid 表示主题，position 表示该帖在该主题中的位置（类似于楼层的概念）。

所以在原来 MyISAM 中可以方便地实现 position 在各自的主题下自增。

给 position 单独添加索引后可以将引擎改为 InnoDB，但是 position 在全表范围内自增了。

也就是说，如果发布一个新主题，那么这个主题帖的 position 就不是1，而是整个数据库中最大的 position 再加 1。

虽然不影响页面中帖子的排序和楼层号显示，但不知道会不会有其它问题，所以最好把它改过来。

给表 pre_forum_post 添加一个触发器，在插入前（BEFORE INSERT）

BEGIN
    DECLARE max_position INT;
    
    SELECT MAX(position) INTO max_position FROM pre_forum_post WHERE tid = NEW.tid;
    
    IF max_position IS NULL THEN
        SET max_position = 0;
    END IF;
    
    SET NEW.position = max_position + 1;
END

在上面触发器的定义中，NEW 指即将要插件的一条记录，在新插入的帖子所在主题中寻找最大的 position 赋值给一个 INT 变量，如果找不到就赋值 0，然后 +1 赋值给新的 position。

这样就实现了与原来相同的效果。

用同样的方法给表 pre_common_member_grouppm 添加触发器。

如果帖子有分表，给每个分表添加触发器，下次有新的分表也要记得添加。

核心文件路径：/theme/html/demo*/src/js/components/core.datatable.js

所有参数的默认值见该文件 3369 行起。

data：

data.source：

query: {
}

{
    'x-my-custom-header': 'some value',
    'x-test-header': 'the value'
}

function (raw) {
    console.log(raw)
    // sample data mapping
    var dataSet = raw;
    if (typeof raw.data !== 'undefined') {
        dataSet = raw.data;
    }
    return dataSet;
}

layout：

{
	overlayColor: '#000000',
	opacity: 0,
	type: 'loader',
	state: 'primary',
	message: true,
}

{
	sort: {
	    asc: 'flaticon2-arrow-up', 
	    desc: 'flaticon2-arrow-down'
	},
	pagination: {
		next: 'flaticon2-next',
		prev: 'flaticon2-back',
		first: 'flaticon2-fast-back',
		last: 'flaticon2-fast-next',
		more: 'flaticon-more-1',
	},
	rowDetail: {
	    expand: 'fa fa-caret-down', 
	    collapse: 'fa fa-caret-right'
	},
}

{
	// 按回车键确认
	onEnter: false,
	// 文本内容
	input: null,
	// 搜索延时
	delay: 400,
	// 键名
	key: null
}

layout.columns：

其它：

translate: {
    records: {
        processing: '加载中...',
        noRecords: '没有找到相关内容',
    },
    toolbar: {
        pagination: {
            items: {
                default: {
                    first: '首页',
                    prev: '前一页',
                    next: '后一页',
                    last: '末页',
                    more: '更多',
                    input: '请输入跳转页码',
                    select: '设置每页显示项数',
                },
                info: '当前第 {{start}} - {{end}} 项 共 {{total}} 项',
            },
        },
    },
},

暂时没有找到对字符串内容进行自动 HTML 编码的属性，这可能带来 XSS 攻击风险，在 remote 方式中必须在服务端预先 HtmlEncode。即使在 layout.columns.template 中进行处理也是无济于事，恶意代码会在 ajax 加载完成后立即执行。

方法和事件：待完善。

更多信息请查询官方文档：https://keenthemes.com/keen/?page=docs&section=html-components-datatable

在 Discuz! 论坛中，帖子的楼层号是从主题开始计的，即“楼主”是 1#，“沙发”是 2#，“板凳”是 3#，“地板”是 4#，从 5# 开始直接以数字显示，所以我们在计算中奖楼层时，应排除主题帖所在的 1#。以活动截止时的最大楼层号 1000# 为例，允许中奖的楼层数应为 999。据此设计了以下中奖算法：

1、将****年*月*日的上证指数收盘价（含两位小数）×100
2、将得到的 6 位数字按倒序排列
3、用这个新的 6 位数除以总的回复楼层数（即活动截止时的最大楼层号－1），得到余数
4、将余数＋2 即为中奖楼层
以2020年9月30日上证指数收盘价为例：3218.05×100=321805，倒序后是 508123，若截止时间前的最大楼层号为 1000，那么 508123÷(1000－1)=508 余 631，则中奖楼层号为：631＋2=633。

注：

股市 15:00 收盘，但更新收盘价会延迟若干秒，因此稍候查看收盘价更为准确。

论坛发帖会有延时，特别是在抢楼这种高并发的情况下，在“抢楼主题”类型中设置了结束时间后，实际结束时的最终一个回帖的时间仍然可能超过活动截止时间（比如超过 1 秒），所以应在活动说明中明确具体以哪一个楼层结束。

其它活动说明：如不按规定回复中奖无效，不重复中奖的顺延方案，中奖楼层不存在的顺延方案等。

上证指数实时获取接口：http://hq.sinajs.cn/list=sh000001

返回结果例：var hq_str_sh000001="上证指数,开盘价,昨收价,最新价,最高价,最低价,0,0,总手,金额,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,日期,时间,00,";

特别注意，传入不同股票代码返回结果数据中的保留小数位数不同，上证指数保留了四位小数，应四舍五入保留两位小数后参与计算。

关键词：prefers-color-scheme

方案一：CSS

媒体查询为开发者提供了系统主题检测的属性：prefers-color-scheme，有三个可用的值：no-preference、light 和 dark。

/* light mode */
@media (prefers-color-scheme: light) {
    body {
        background-color: #f0f0f0;
    }
}

/* dark mode */
@media (prefers-color-scheme: dark) {
    body {
        background-color: #3e3e3e;
        color: #fff;
    }
}

方案二：JS

if (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) {
    // dark mode
}

与 2.X 不同的是，待审核的主题和回复是分开两张表存放的：

pre_forum_thread_moderate

pre_forum_post_moderate

字段 status 值含义：

0：未审核

1：已忽略

不在该表中的为已通过。

Dark Mode 亦称为 暗黑模式、黑暗模式、暗色模式、黑夜模式、深夜模式、夜间模式 等，以下介绍几种常用软件的 Dark Mode 的设置方法。

iOS：

【iOS 13+】在 设置 - 显示与亮度 - 选择“深色”

【iOS 11+】在 设置 - 通用 - 辅助功能 - 显示调节 - 反转颜色 中开启“智能反转”。

“智能反转”缺点：第三方应用上显示的图片会以“经典反转”的方式展示。

Android：

设置 - 显示 - 主题模式，选择“暗色主题”

版本支持：Android 9.0 - Pie（Android P）

macOS：

系统偏好设置 - 通用 - 外观，低版本系统中勾选“使用暗色菜单栏和 Dock”，高版本系统中直接点击预览图选择主题。

版本支持：在 OS X Yosemite 10.10 中提供支持，在 macOS Mojave 10.14 中全新升级。

Windows：

桌面右键“个性化”（或从 Windows 设置中打开），在“颜色”选项卡，选择默认应用模式“暗”。

版本支持：Windows 10 October 2018 Update（版本 1809）

Microsoft Office：

文件 - 选项 - 常规 - Office 主题：黑色

在一个组件中设置后（如 Word），会在其它的组件中同时生效（如 Excel）。但 Visio 没有“黑色”主题（至少在 2019 中），我尝试更改为“深灰色”，Word 也变为“深灰色”，然后在未关闭 Visio 的情况下再次更改 Word 为“黑色”，Visio 界面竟然也变成了“黑色”，设置选项中为空白。

版本支持：Office 2016

Adobe Photoshop：

点开 菜单：编辑 - 首选项 - 界面，根据自已喜爱更改颜色方案。

版本支持：Photoshop CS6（可能更早），新版中已默认启用

CorelDRAW：

点开菜单：工具 - 选项，左侧展开 工作区 - 外观，主题选择“暗”或“黑体”。

版本支持：CorelDRAW X8（可能更早）

Microsoft Visual Studio：

点开菜单：工具 - 选项 即可更改颜色主题为“深色”（左侧选项卡为 环境-常规）。 

版本支持：Visual Studio 2012

微信开发者工具：

点开菜单：设置 - 外观设置，选择“深色主题”

仅在文件代码面板有效

Microsoft Edge：

设置 - 自定义 - 选择一个模式 - 暗

Chrome：

在 Chrome 74 版本中支持。

其开发者工具（F12）早在 50 版本中已提供 Dark 主题，在开发者工具右上角展开竖状三点图标 - Settings - Theme: Dark

Windows 的 Chrome 的 Dark 模式无需设置，会根据 Windows 自身是否为暗模式来调整。

因其 Dark 模式不容易区分当前标签页，如需禁用 Dark 模式，参此文

Adobe Acrobat Reader DC：

点开菜单：视图 - 显示主题 - 深灰

HBuilder X：

点开菜单：工具 - 主题 - 酷黑

Code Write：

设置 - Editor - Theme - Dark（默认已启用）

原文标题：新手还在学习排版配色，高手已经在做内容设计了…

任何事物的呈现和传达都需要通过一定的媒介，在媒介承载的过程中，均会产生损耗。我们设计的目的之一就是将所传达的内容在媒介承载的过程中让损耗降到最低，呈现出我们想要给受众的东西，且能够被快速察觉、理解和获取（主动及被动的）。

文本作为语言沟通的书面化，一直以来承载着大量的信息，也是生活中最常见及熟知的方式。

当前人们快节奏的生活状态、快消的阅读习惯以及注意力分散，所以需要我们通过设计手段来减少视觉、心理及认知压力，让用户能够快速定位、理解和消化。同样，我们也需要根据目标、任务甚至品牌的诉求，从而更好的服务于主题。

以下是工作中一些心得和总结，旨在从更多角度去思考和完善，让文本信息能够得到更好的呈现和传达。

一、前提

前提是做事的先要条件。

• 达成目标

• 了解受众

• 具体情景

二、目的

目的是做这件事的动力。

• 满足用户所需，帮助完成工作；

• 简单直接，有效传达；

• 达成一致，统一规范可实施。

三、角度

角度是考虑要做的内容。

• 准确性

• 一致性

• 易读性

• 内容调性

1. 准确性

秉持文本信息准确明了、简达明意，无歧义

首先要明确所传达的群体对象，尽量避免使用行话，使用「用户」能直接理解的文本信息，当然相应的专业词汇也应给予良好的解释和说明。

案列：我们将 「循环次数」 更改成 「轮播次数」 ，「循环次数」会让人产生思考（循环一次是播放一次还是两次的），而 「轮播次数」 就显得更加直观明了且更符合上下文的语境。

用词完整、阐述直接

用词完整，例如保存修改，而不是简化为保存；阐述直接，避免模棱两可，模糊不清。

内容传达上应做的良好的「自解释」

例如：涉及操作事件的文本命名应根据上下文准确的进行表达，而不是含糊其辞的，使文本能够准确的解释和表达将要发生的事件及行为。

寻找更加合适的表达方式

例如：未输入提示，「XXX不能为空」 和 「请输入XXX」，第一个在表达上其实有一些责怪，而第二个表达同样说明了意思，但在口吻上却更加温和，并告诉用户应该怎样操作和行动。

避免错别字

错别字只会拉低产品的品质和用户内心的形象，请务必严格检查。避免把 「登录」 写成 「登陆」。

准确应用标点符号

标点符号能够赋予文字节奏，表达语气以及对内容的组织。准确应用，能够帮助文字更加有效传达和被人理解。

• 常用标点符号用法简表

• 《标点符号用法》

2. 一致性

同一事物用词一致，消除重复

例如，涉及新建的操作，一会用「新建」，一会又用「新增」、「创建」或者「添加」；涉及称谓，一会用「你」，一会又用「您」、「我」或者「我的」；涉及帮助，一会用「支持」，一会用「帮助」或者「服务」等等，我们应该消除这些重复，统一用词。

相似场景、意思和语境下句式表述一致

例如，未输入提示，应避免「请输入XXX」和「XXX不能为空」等不同的表达方式。

标点符号规范

根据符号使用规范并结合自身产品情况具体定义。例如：全角和半角，如常见「：」和「:」，截断省略「…」等等。又如：标题，提示文本不加结束符号等。

时间表达规范

时间是一个记录戳，需要根据与当前进行定义，显示不同的格式。

例如：今天发生的（自0时起），显示时分（24h）；今天之前发生的，显示月-日（例如02-12）；跨年，显示年-月-日（例如2017-12-30）。

数字使用规范

例如：统计数据统一使用阿拉伯数字。

大小写使用规范

专有名词大小写，单位符号等。例如：iOS

中西文混排规范

中英文之间需要加空格等。

代称一致

第一人称「我」，第二人称「你」和「您」，具体根据场景进行使用，同场景统一一致。你和您请不要随意混用或均使用，应当统一。

操作名称与目的页面标题一致

常见于移动端，在 PC 常见于链接及导航。

3. 易读性

简化内容，避免啰嗦

简单而直接，避免长段使用短语，保持措辞简洁，让读者感受到阅读乐趣，引诱他们深入阅读。

打破复杂冗长

通过段落、有序列表（项目编号）、无序列表等方式使内容结构化，便于视觉扫描。

• 段落：根据句意，进行分段呈现。

• 有序：当项目顺序或优先级重要（程序等）时，使用编号列表。

• 无序：项目相关时使用项目符号列表，但顺序或优先级无关紧要。

• 结构化：节奏和韵律。例如，电话号码或者银行卡号，使用连字符或空格使其容易被读取和识别。

重要内容突出显示

让用户首先看到最重要的内容，而不是去寻找它们。

经过良好的排版

合理使用文字大小：使用合理的字体大小，太小太大对于屏幕阅读来说都是低效率的。网页端字体大小一般使用不低于12px，更加直观易辨（对于多数人而言）的字体14px和16px；移动端字体大小不小于10pt（sp），12-18pt（sp）都是常用的字体选择范围。

颜色与对比度：颜色我们需要考虑色彩本身（色相、明度和饱和度）给人直观感受和文化寓意的，以及文本与背景之间是否有足够的对比度，从而方便人们可以更加直观舒服的进行阅读。W3C 建议的视觉呈现文本和文本的图像具有对比度至少为4.5:1，大型文字和图像的对比度至少为3:1，具体详情可了解 Contrast (Minimum):Understanding SC 1.4.3

字间距：汉字属于方块字，原则上文字外框彼此紧贴配置，称作密排；在各字之间加入固定量的空白来排列文字，称作疏排；减少字距，使得文字外框一部分重叠，称作紧排。文字排版时，会根据具体情况对字间距进行调整。大多时候我们对采用疏排方式，增加字间距，以提高易读性。

行高：具有良好的行距的文本，更易阅读和引导用户视线。与行之间的空白称为行距，文字尺寸+行距=行高，行距一般介于文字尺寸的50%–100%之间，自然行高的设置一般为文字尺寸的1.5-2倍。文字尺寸较小时，行高设定也会相对较小。行距一般不会超过文字尺寸，因为这样并不会因此而增加易读性。

段间距：段落与段落之间的距离，段间距大于行间距，行间距一般设置为文字大小的2-3倍之间，合适的段间距能够缓解用户的视线压力，起到很好的节奏及阅读定位。

行字数：一行的文字数量。一行文本过长，用户需要去移动脖子或视角，易造成的眼睛疲惫感，造成阅读困难；此外，在大段文本中找到正确的行也将变得困难。过短视线需要不断换行，从而打断了读者阅读节奏，造成尴尬的断裂效果；行太短也会造成用户在一行没读完的情况下去关注和阅读下一行。

虽然至今汉字依然没有正统的方法和具体行字数来衡量文本的完美长度，个人经验在12px下30-60汉字左右（包含标点），具体也要根据内容、人群等约束和变量，当然最重要的是要相信你自己（专业的设计师）的眼睛和判断。

词语尽量避免同行断开：例如，行末为「跳」，下行开头为「转」，读起来就有断句的存在感。

对齐方式：中文（简体）排版一般遵循左对齐的原则，符合我们从左到右的阅读习惯。文字居中，本身不适合可读性，但可用于许多小段文本块。右对齐在表格设置中，可用于数字的对比等应用。

符号避头尾：中文中行首遇到不能置于行首的标点符号，必须要将移动到前一行行尾。

合理突出：对于关键字、要点通过位置、加粗、比例大小和色彩处理等，以便让用户直接关注到。当然也要控制突出数量，毕竟都是「重点就没有重点」，过多也会扰乱和分散用户的注意力。

链接：链接文本需要很好的说明用户将要去何处，可以使用蓝色或者下划线标示出链接的样式，这是用户熟悉方式。神奇的「下划线」为体验赋能

尽量少用斜体：PC 和无线端的各个官方的中文字体包并没有斜体预设，生拉硬扯的倾斜在一定程度上是影响美观度，并造成一定的阅读困难。如果是为了突出或区别可以考虑使用字重、大小和颜色等方式。

层级处理：有对比就有层级关系，可通过大小、字重、色彩、距离、方向、纹理、形状、背景等等方式，可以让整体排版布局更加富有层次结构，让内容的可读性得到明显的提升。 例如：标题、副标题、引用和内容也是一种层级处理（结合了大小、色彩或者距离等等）。

留白：合适的留白可以更好的烘托内容主题，缓解视觉压力。

数量信息前后有汉字时需加空格：不加空格会出现前后拥挤的视感，另一方面可凸显数字信息。

4. 内容调性

依据产品定位，通过文本表述传递其相应的价值观和情感诉求

任何产品都有所针对的人群及自身的品牌形象。C端产品和 B端产品，儿童产品和成年人产品，所使用的语言表达方式自然也都是不一样的。

依据不同状态和用户群体

根据状态（正面、中性和负面）和用户（新手、中级用户和专家），使用合理的语调及用词规范，以适应不同的情境和状况。

始终坚持积极主动的，而不是消极令人沮丧

「请输入内容」与「错误，内容不能为空」，同样的意思却有不同的感受，从积极的一面表达就是传播正能量。

四、通用产出物

• 字体

• 日期和数字

• 标点符号

• 大小写

• 中英文混排

• 代称

1. 字体

字族 Font-Family

Font-Family 属性设置的字体系列。Font-Family 属性设置多个字体作为一种「后背」机制，浏览器不支持第一种字体，它会尝试下一个字体。

如果字体系列的名称超过一个字，它必须用引号，如Font-Family：「宋体」。

对于依附在 PC 端产品而言，统一的字体规范，以保证在不同平台、不同浏览器下保持良好的美观性和易读性。

以下呈现的是 Ant Design 的字体家族。个人在使用了多款后，觉得最好的一份：

font-family：「Chinese Quote」, -apple-system, BlinkMacSystemFont, 「Segoe UI」, 「PingFang SC」, 「Hiragino Sans GB」, 「Microsoft YaHei」, 「Helvetica Neue」, Helvetica, Arial, sans-serif,「Apple Color Emoji」, 「Segoe UI Emoji」, 「Segoe UI Symbol」;

如果大家想了解字体排列前后顺序的玄机可以认真看《推荐！Web中文字体应用指南》这篇文章。

以下备注区域，是我在使用字族的路上磕磕碰碰所收集到的有限知识，也算知其所以然了，若有不妥、错误和缺漏欢迎指正。

备注区域：

-apple-system：macOS 和 iOS平台的 Safari 调用 SanFrancisco 字体

BlinkMacSystemFont：macOS Chrome 调用 SanFrancisco 字体

Roboto字体，由 Google 开发，是 Android 4.0「Ice Cream Sandwich」及后面Android版本的默认字体。

Segoe UI 取代Tahoma，Windows 从 Vista 开始的界面默认西文字体。利用 ClearType 技术的新字体 Segoe UI 看起来比现在略显僵硬的 Tahoma 更加人性化。

Tahoma 被采用为 Windows 2000、Windows XP、Windows Server 2003及 Sega 游戏主机 Dreamcast 等系统的默认字型。

Arial 是一套随同多套微软应用软件所分发的无衬线体 TrueType字型。

Microsoft YaHei 微软雅黑，该字体将作为 Windows Vista 的默认字体取代2001年推出的 XP系统下默认的宋体汉字，以支持高清显示的 ClearType 功能。

Simsun 宋体，一直是简体中文版 Windows XP系统及之前版本的默认字体。但由于字体的特性，在Windows Vista 中已经改用支持 OpenType 的微软雅黑，

HanHei SC 威锋瀚黑，现苹果简体中文，OS X 10.11 El Capitan 开始，

STHeiti 华文黑体，分为「黑体-简（Heiti SC）」和「黑体-繁（Heiti TC）」，OS X 10.6 Snow Leopard 直至 OS X 10.10 Yosemite。

Hiragino Sans GB 冬青黑体

STXihei 华文细黑，是苹果公司 Mac OS X9 以及之前版本的操作系统的中文默认字体，截至 OS X 10.5 Leopard。

PingFang SC 为 iOS9.0 以后系统自带中文字体。

SanFrancisco iOS9 正式发布之后，替换了之前的 Helvetica Neue 成为了 iPhone/iPad 系列设备的默认字体。

Myriad Set Pro 苹果向 adobe 公司定制了一款西文字体，是以 myriad 为原型的，完成后在市面上叫做「myriad set」，后期升级为「myriad set pro」。

Helvetica Neue 意为「新 Helvetica」

Helvetica 是苹果电脑的默认西文字体

sans-serif 并非一个具体字体，而是css的通用字体族，具体是什么字体是由浏览器设置决定的。

字号 font-size

标题，内容，注释说明等不同字号的大小。

字间距 letter-spacing

根据不同字号，及文本数量进行字间距定义。

行高 line-height

设置行高能很好的解决，缓和上下文本之间拥挤在一起的情况。

颜色 text-color

这里主要讲下注意对比度的问题，很多产品在这一点上都忽视了这一点，搞出了所谓的「小清新」。

• 你可以查看完整的《网页内容可访问性指南WCAG 2.1》

• 《色彩无障碍设计（Color Accessibility）之「对比度」的探索》中推荐的工具很实用

• 《「完美」的字体系统搭建与维护指南》

• 《掌握具有共享样式的文本系统》（搭梯子访问）

2. 日期和数字

日期

使用完整数字日期，如：2018-01-02。

时间

• 使用24小时制，如 13:01:29

• 具体到时分秒，如当前对话显示 09:01:02

• 使用半角 「:」

• 日期和时间之间包含一个空格，如 2018-09-01 13:01:20。

数字

使用阿拉伯数字。

对四位或更多位数的数字使用逗号。

对手机号码使用前后无空格的连字符「-」。不要使用点，空格等其他符号。

数字范围使用前后无空格的连字符「-」。

正负数后不加空格。

数字和字符之间不需要空格

货币

人民币符号（¥）在数字前面，精确到小数点后两位。

测量单位

储存单位（B、kB、MB、GB、TB），在数量和度量单位之间包含一个空格。

对于长度「毫米（mm）、厘米（cm）、分米（dm）、千米（km）、米（m）、微米（μm）、纳米（nm）等」和重量「千克（kg）、克（g）、毫克（mg）、微克（ug）等」等测量单位应为小写（电流单位除外）。在数量和度量单位之间包含一个空格。

屏幕单位「像素（px）、逻辑分辨率（pt、dp、sp）、英寸（in）等 」应为小写。在数量和度量单位之间包含一个空格。

在连续列出尺寸时，将度量单位放在末尾，而不是在每个数字之后，并包括一个空格。

在所有情况下，数字和单位之间包含一个空格。HTML代码的最小空间是 & hairsp; 或 & #8202;

测量单位分为基本单位和导出单位。国际单位制共有7个基本单位长度：

长度：米 m；

质量：千克（公斤） kg；

时间：秒 s；

电流：安[培] A；

热力学温度：开[尔文] k；

物质的量：摩[尔] mol；

发光强度：坎[德拉]cd；

并由物理关系导出的单位称「导出单位」 。

3. 标点符号

省略不必要的标点

标题、副标题、输入框下的提示文本、输入框占位符、悬停提示中的文本、Toast中、弹窗等短句，在遣词造句时尽量避免标点符号，始终末尾不要使用句点。

有序列表和无序列表

使用冒号引入项目列表，列表后不使用标点。

使用列表来表示步骤、组或信息集。简要介绍列表的上下文。在顺序重要时列出数字列表，比如当您描述流程的步骤时。当列表的顺序不重要时，不要使用数字。

常用标点符号规范

• 空格：链接与前后文本之间增加空格；数字和单位之间包含一个空格；电话号码与前后文本包含一个空格；

• 省略号「…」：半角省略号，超出截断代替省略文本；

• 星号「*」：半角星号。表单必填、说明备注；

• 连接号「-」：半角连接号，前后无空格，如2018-01-04，2008-2018；

• 冒号「:」：半角冒号，用于时间的表示，如16:45 ；

• 冒号「：」：全角冒号，用于表单；

• 破折号「——」：中文破折号占两个汉字空间；

• 书名号「《》」：产品中常用于法律条文。

相关推荐：

• 《标点符号用法》

• 常用标点符号用法简表

• 中文排版需求

• 写给大家看的中文排版指南

4. 大小写

专门名词大小写

文件格式

当一般引用文件扩展名类型时，全部大写而不包含句点。

• GIF

• PDF

• HTML

• JPG 格式

引用特定文件时，文件名应该是小写的：

• 内容策略-设计完全手册.pdf

• 皮皮虾.gif

• 西湖.jpg

• hot.html

5. 中西文混排

中英文之间需要加空格

中文与数字之间需要加空格

中文为主，使用全角符号且与英文或数字之间不加空格

6. 代称

为了表达双方的平等，避免使用「您」。使用「你」代称客户/用户，借以表达客户的口吻。在客户/用户为主的情况下使用「我」。避免同一句子中混用「你」和「我」。

对于「您」还是「你」的使用并非绝对，主要看行业以及服务的对象

在《胜于言传-Web内容创作与设计的艺术》中作者建议：

当用户提问的时候：

• 在问题中使用「我」和「我的」（用户的声音）

• 在答案中使用「你」和「你的」（应用对用户说话）

• 用「我们」和「我们的」代表回答公司

当应用提问的时候：

• 在问题中使用「你」和「你的」（应用向用户提问）

• 在答案中使用「我」和「我的」（用户的声音）

• 用「我们」和「我们的」代表回答公司

五、指导建议

• 操作行动

• 文本说明

• 句式结构

• 语音和语调

• 写作建议

1. 操作行动

按钮

清晰可预测。应该能够预测当点击按钮时会发生什么。

行动号召。按钮应始终带有强烈的动词，鼓励行动。为了给用户提供足够的上下文，在按钮上使用 {动词} + {名词} 格式，除了保存，关闭，取消或确定等常用操作。

以下是常用词的含义，以避免不恰当或混淆使用：

所有具体的用词需结合场景和生活习惯。

链接

使用描述性的链接文本。切勿使用「点击这里」或「这里」作为链接文本。

如果一个链接出现在句子的末尾或逗号之前，不要链接标点符号。

链接使用蓝色，这是用户习以为常的认知，并明确区分点击和未点击的区别。

2. 文本说明

对操作说明，功能说明，名词（术语）解释，提示信息等进行用户测试，是否明白其意，记住这是一个不断优化的过程。

以下是产品内的主要文本：

• 操作文本：按钮；

• 导航文本：全局和局部导航、目录、链接；

• 说明文本：功能说明、术语解释；

• 提示文本：弹框、toasts、操作反馈、系统反馈、通知等；

• 操作说明：功能引导说明，操作文档；

• 标题和副标题：弹框标题、操作说明标题、法律条款标题等；

• 条款：法律条款、申明；

• ALT：为图片添加文字说明。

3. 句式结构

通用场景下的语句可进行归纳在一起，形成统一的句式结构。

例如：

操作反馈：成功直接提示结果，失败显示结果+说明原因+如何解决。

二次确认：先说明利害，再询问是否操作。

标题：「动词」+ 「名词」格式等。

4. 语音和语气

这听起来是谁，什么样的语音和语气能代表我们，我们想传达什么的形象。

因此，你可以建立一套准则，一般而言准则应该：

• 基于产品当前的业务；

• 准则可被执行，避免过于空洞；

• 易于记忆，3-5个尚可；

• 并随着产品发展和愿景的变化而不断适应改进。

例如：

积极主动

始终坚持积极主动的，而不是消极令人沮丧。

自信专业

避免听起来傲慢、亲密、孩子气或其他不适当的或非正式的。

友好尊重

依据不同状态（正面、中性和负面）和用户群体（新手、中级用户和专家），使用合理的语气及用词规范。

5. 写作建议

个人写作过程中的一些小感悟：

• 好的结果是不断修改来的，修改的基础是要先写下来，所有先记录而不是停留在脑子里，这才是一切开始的基础。

• 记住用户很忙且没有耐性，甚至不聪明，这会不断的促使你修改调整。

• 找人阅读并呈现结果，并询问其含义和建议。这是检验的最佳实践。

• 过段时间再来看看，或许有更好的方式。

结尾

这并非是一个完整的（内容层面可能保存图片风格，插画图标等），还有很多地方可以补充。重要的是找到适合你的产品，并有这样的意识去不断优化你的产品内容，从而更好的服务你的用户。