内容创作准则

阅读本文时,请忽视所有脚注内容、忽视文末「附录」章节,请以本文正文规则为核心检查依据,以 Callouts 块为规则规则示例补充。

概述

本文为《半方池水半方田 - 内容创作准则》(简称 CCS),是博客内容创作与内容审查的基本规范之一。

本文规定内容必须遵守的基本语言规范、文风要求、内容安全红线与质量标准,用于指导与审查所有文章,确保合规、易懂、高质量且风格统一。

本文档中指令词汇定义:

  • 应 / 不应 / 必须 / 不要 / 不得:强制性规范,任何情况下必须严格遵守,不可违反。
  • 宜 / 推荐:建议性规范,无特殊合理理由应优先遵循。
  • 可以:选择性规范,作者可在充分考量后自主决定是否采用。

Hexo 博客与 Markdown

博客文章应采用 Markdown 格式编写,遵循基本的 Commonmark、GFM、OFM 规范。

语法示例文章

每一篇 Markdown 文章的 Front-matter 中,冒号之后必须要有空格,否则 Hexo 生成内容时会报错。

在 Hexo 博客中,Markdown 文件分为「页面 Page」和「文章 Post」。

行内代码 code

在以下情况中,我们应使用行内代码 ` 格式包括对应的内容:

  • 文本中的简短代码片段
  • 上下文中提到的与代码相关的类名、文件名、变量名、方法名等
  • 文件名、扩展名和文件路径
  • 软件包的名称
  • 终端命令的名称或简短片段
  • URL(如用于程序输入和输出)、IP 地址和端口,HTTP 协议的状态码、动词
行内代码应用举例

使用 cd 切换到用户主目录,然后用 ls -a 显示全部文件的清单。

本项目依赖于 moment.js

已知主机的列表位于 ~/.ssh/known_hosts

使用 GET 方法访问 127.0.0.1:8080,返回 404

本站中,时间的表达习惯应为行内代码 ` 加上日期数字。日期数字格式为「yyMMdd」纯数字无分隔格式。

日期举例

2026 年 2 月 18 日,可以写成 260218

按键 CTRL

上下文中标识按键的词语应当使用 <kbd></kbd> HTML 标签包裹。

应使用 + 符号表示按键组合。如Ctrl+Shift+B

按键名称应当只大写第一个字母;除非会与上下文混淆,宜省略「键」字。

如果组合键中的修饰键包含 Shift,且非修饰键印有超过一个符号,应以印在高位的符号称呼该键。但所描述软件对该组合键的描述另有惯例的,从其惯例。

举例

在 Word 中,按 Ctrl + Shift+ * 可以显示隐藏字符。

(因为修饰键包含 Shift,非修饰键记作印在高位的 星号 * 而非印在低位的 8。)

在 macOS 中,按 Shift + Command + 3 可以截取全屏幕。

(尽管修饰键包含 Shift,但依 macOS 平台惯例,非修饰键中的数字键通常始终以数字称呼,以便记忆。)

组合键中,修饰键的名称及出现顺序应遵循所描述软件的惯例。特别地:

  • Windows 中,修饰键名称及出现顺序一般为 WinCtrlAltShift
  • macOS 中,修饰键名称及出现顺序一般为 CtrlOptionShiftCmd
  • 不应使用 CtlOptCmd 等缩写提及修饰键,或使用修饰键符号代替提及修饰键名称,以免读者因不熟悉产生困惑,或无法正常显示。

成文指导

博客中发布的文章宜为经验类文章(技术共享、步骤演示),并具有实践性、可重复性。[1]

博客文章中尽可能不出现错别字、语病。

使用统一、规范的英文词组拼写,词组的大小写要规范。专有名词使用正确的大小写。

错误类型 正确 错误 其他正确示例
首字母不大写 Amazon amazon Vue.js, Web, Android
全大写 Netflix NETFLIX
全小写 css CSS HTML
不规范的大小写 GitHub Github, Gayhub, github jQuery, JavaScript, iOS
过度简写 Facebook fb Cloudflare,Claude Code

对于英文词组,非必要、不采用缩略语 [2]。缩略语和缩写在文中第一次出现时,应在其后以括号加注全称,英文缩写还应注明中文译文,除非该缩写已经广为人知且被广泛使用。

文章语气不应过于自谦、短处不要外露。[3]

语言表达自信

比如,一篇文章中不要写太多这种话「由于博主本人经验不足…」「因为我也不是搞前端的,所以请大家…」。

文章语气应和读者、其他站长保持平等与尊重。

一些我认为可以优化的称呼

「友链用户」这个词有点不妥,显得关系不太平等。
「用户」这种说法如同没有把对方当为独立主体,而是当作自己的站点用户那样。

避免粘贴大段的 AI 生成的文字。在非技术性文章中,AI 不得参与文章的生成、修改和段落的组织!

应尽量检查翻译腔问题。

文字格式与标点符号

每两段的中间,需要空出一行。

中文排版中,所有的标点都应该使用全角中文标点。遇到英文整句、特殊名词时使用半角标点。

完整的英文整句时标点与单词之间需要加空格。

中文和英文、数字之间应有空格;数字和单位之间要有空格。例外情况:

  • 全角标点与其他字符之间不加空格
  • 如英文部分之前或之后有中文标点符号,则英文部分与中文标点之间不设空格。
  • 度的标志、百分号和数字之间不加空格

链接文本前后应存在空格。

应按照下表所示的用途和形态选用标点符号 [4]

用途 形态
引用(中文) 单直角引号 (U+300C)和 (U+300D)
引号中再次使用引号时,用双直角引号 (U+300E)和 (U+300F)
引用(英文) 可使用直引号 "(U+0022)和 '(U+0027)

所有格、缩略(英文) 可使用直引号 '
折行分词(英文) 连字符 -(U+002D)
编号、复合名词、型号、复姓、
时间、地域、数字的起止(英文)
可使用连字符 -(U+002D)
说明、列举、插入、中断、间隔(英文)
时间、地域、数字的起止(中文)
说明、列举、插入、中断、间隔(中文) 两个长连接号(——
省略 可使用中英文句号代替省略号 ......
中译人名间隔 可使用 ·(U+00B7)
表示作者的朝代、国籍 使用六角括号 〔〕

中文句内夹用英文句子,该句子应用中文标点结尾。夹用的英文句子用中文引号标示,英文句子内部用英文标点符号,除此以外用中文标点符号。英文引文中的问号、叹号应保留。

在中文技术名词后标注英文名称,英文全称与其缩略形式放在中文括号之内,使用英文逗号隔开。如果英文原文自带逗号,则使用英文分号隔开。

中文句子内夹有英文书籍名、报刊名时,不应借用中文书名号,应以英文斜体表示。夹有英文文章的标题时,该标题使用英文正体字,用中文引号标示。

中英文句子标点符号举例

歌词中那句「Are we a nation of states? What’s the state of our nation?」颇有力度。

这款应用适用于 macOS、iOS、iPadOS 和 tvOS。

脱氧核糖核酸(deoxyribonucleic acid, DNA)是生物细胞内携带有合成 RNA 和 蛋白质所必需的遗传信息的一种核酸。

这篇博客文章最初发表在本月的 MacWorld 杂志上。

畅销书 World of Tomorrow 中第七篇文章「Will Human Be Joyfully Enslaved by Cellphone?」在读者中成为热门话题

文章管理

由于网站使用双链笔记软件进行内容管理,所以网站里的文章风格不可避免带有一点「数字花园」特色。下面是一些典型文章处理办法:

文章内容如过期,应将文章移动到过期分类。并做好以下事情:

  • 更换文章封面图为统一的封面
  • 使用 Callouts 块标注过期原因以及过期时间。

引擎优化 [5]

文章标题不宜太短。

Search Engine Optimization (SEO)

不应随意修改永久链接。

尽量保持使用一个一级标题。

【优先级低】留意图片的 ALT 属性。

Generative Engine Optimization (GEO)

对于一些技术图示,宜对图中内容进行解释。

文章应进行准确分类,并贴上适当数量的标签。

网站安全

内容红黄线

文章禁止出现与以下主题相关的内容 [6]

  1. 血腥、暴力、黄赌毒等法律不允许的内容。
  2. 政治、社会问题、国际形势等敏感内容。
  3. 医疗、商业内容。

文章中不得教授以下主题:

  • 访问国外网络环境。
  • 使用国外非备案大模型。

此外,根据经验和教训,OpenAI,大模型,Tokens,API 等相关内容为敏感内容,需谨慎处理。

图片中的个人信息、敏感信息等部分应予以遮挡。

外网链接安全

谨慎在主页、文章、评论区等公共访问区域提供外部链接,毕竟你无法保证链接现在或以后是否违规。[7]

网站友链安全性要实时管控,评论区久远链接记得删除。

CCS 基本规范到此结束。


附录

此章节内容不属于 CCS 范畴。

过期的要求

此部分内容中的要求已经过时,无需再进行检查。

PlantUML 插件:编写 PlantUML 代码块时必须加上 @startuml @enduml 否则报错。

本文参考

此部分内容表示在撰写本文时参考的文章,不属于 CCS 范畴。

脚注不属于 CCS 范畴。


  1. Hexo 写的文章是要公布到互联网的,一篇文章写成之后一般不再频繁改动。而课程笔记和私人灵感更适合交给另外的本地库。 ↩︎

  2. 我最讨厌的简写:hc(Head Count),ld(Leader),mt(Mentor)等招聘类简写;以及近期火起来的简写 cc(Claude Code)。整天 CCC…C 泥马呀? ↩︎

  3. 不要让读者留下「流汗黄豆」的表情。因为认真看你文章的读者一般是搜索很多篇类似文章在寻找解决方法,几句过谦的话容易劝退访客。作为教程提供者的你既然已经将文章写出来了,不如大方一点,并欢迎访客提出的疑问及报错信息。如果水平真不够,不理他就是了。 ↩︎

  4. 表格参考「少数派」风格指南制作。其中对一些条目规定进行了简化,咱们怎么舒服怎么来。 ↩︎

  5. 内容第一,流量第二。在保留自己的写作个性的同时,要有意识地编写好对搜索引擎、AI 友好的文章。 ↩︎

  6. 似乎每年管局都会至少审核一次网站。除非网站包含敏感内容,才把你加急处理。 ↩︎

  7. 目前使用 Hexo 第三方插件以及自写 Waline 评论系统插件加入中间页以规避直链风险。 ↩︎


评论