| name | hfut-doc-style |
| description | Survive-HFUT 文档语言风格改写、审校和新增 Markdown 内容写作指南。用于编辑 docs/ 下的 Markdown 页面、润色 AI 生成的中文内容、减少 AI 味道、对齐 docs/study/exemption.md 和 docs/enrollment/qa.md 风格、应用 docs/about/standard.md 规则，或审查强调、Emoji、提示框、引用和面向学生的校园文档措辞严谨性。 |
HFUT 文档风格
核心原则（必须遵守）
1. 消除 AI 味道
删除以下词语：
- 总的来说、值得注意的是、在当今时代、综上所述
- 本文将深入探讨、帮助大家更好地了解、具有重要意义
- 首先需要明确的是、与此同时、另外值得一提的是
- 温馨提示、需要注意的是、简单来说
替换方式：
- 直接陈述事实，不加铺垫
- 使用短句，一句一个信息点
- 保留具体信息，删除空泛描述
- 删除冗余的修饰词（"约"、"大概"、"可能"在有确切数据时）
示例：
- ❌ "本文将从多个维度为大家详细介绍校园卡的相关内容，帮助大家更好地了解校园卡的使用方式。"
- ✅ "本页介绍学校发放的实体校园卡，包括用途、充值、挂失和补办方式"
- ❌ "需要特别注意的是，学生必须在规定时间内完成选课"
- ✅ "学生必须在规定时间内完成选课"
2. 保持学生指南语气
使用：
- "可以参考"、"建议提前准备"、"通常"
- "如果你..."、"可以..."、"一般..."
- "各位"、"同学们"
避免：
- "暖心"、"欢迎"、"务必"、"简单理解"
- "宝子们"、"冲就完了"、"闭眼入"
- "超值"、"强烈推荐购买"、"必买"
- "小东西们"等过于亲昵的称呼
删除冗余内容：
- 删除括号内的冗余解释（如"（赔钱的那种，不存在赚你钱）"）
- 删除冗余的开头（如"各位吧友们，考生们好..."）
- 删除冗余的结尾（如"最后，欢迎大家入学..."）
- 删除过时的内容（如":::warning 编者注 此节已过时"）
- 删除冗余的修饰词（如"非常重要"、"非常实惠"）
- 删除详细的查询说明（如"可以在[这个网站]查询，格式为..."）
- 删除无效的问答（如"奖学金金额能用于学费和住宿费吗"）
使用链接替代重复内容：
- 使用
:::info 块链接到详细页面
- 将多个问答简化为一个链接列表
修正不准确的表述：
- 使用准确的术语（如"AP"而非"WiFi 路由器"）
- 使用准确的地名（如"宣城"而非"宣村"）
- 使用准确的物品名称（如"迷彩鞋"而非"解放鞋"）
3. 谨慎处理风险内容
高风险内容（考试、处分、校规、反诈、费用）：
- 保留或添加引用来源
- 使用
:::warning 标注风险
- 使用
<mark> 标注重要区分
- 不要开玩笑
低风险内容（宿舍、食堂、交通）：
- 语气可以稍微轻松，但仍需克制
- 可以使用 "大部分"、"一般"、"可能"、"据反馈"
工作流程
-
阅读目标文件，判断风险等级
-
查看同目录其他文件，保持结构一致
-
参考以下文件：
docs/study/exemption.md（政策、统计、脚注）docs/enrollment/qa.md（问答风格）docs/about/standard.md（官方写作规则）
-
改写时：
- 保留所有链接、脚注、组件
- 删除重复的铺垫句
- 将长段落拆分为短句
-
完成后检查：
- 是否有 AI 味道？
- 是否过度加粗？
- 是否 Emoji 过多？
- 是否改变了事实含义？
-
运行格式检查：
pnpm dlx markdownlint-cli2 --fix "*.{md,markdown}" "**/*.md" "!node_modules/**"
Markdown 规范
加粗使用
可以加粗：
- 必须或禁止的行为（如 "禁止私下转让"）
- 硬性要求、后果
- 容易误解的关键区分（如 "校园卡" vs "校园流量卡"）
- 关键警告（如 "不建议在百度上查自己专业"）
不要加粗：
- 数字、日期、时间（如 "12 分"、"7 月 1 日"）
- 一般性说明（如 "约 6km"、"三甲医院"）
- 列表标签（如
- **核心用途**:）
- 整段文字
- 仅为模拟标签的标题
<mark> 使用
可以使用：
- 搜索关键词
- 需要视觉突出但不是警告的名称
- 长句中的次要提醒
Emoji 使用
可以使用：
details 标题中的一个 Emoji（如 🤡 趣事）- 问答标题中的
❔
- 侧边栏顶级导航标题的一个 Emoji（如果已有惯例）
不要使用：
- 连续多个 Emoji
- 严肃警告块中的 Emoji
- 依赖笑话才能理解的主要答案
删除线使用
不要使用删除线：
- 删除线内容通常应该直接删除，而不是保留
- 如果内容有用，直接陈述；如果内容无用，直接删除
提示块使用
:::tip 用于实用建议:::info 用于简短总结或补充说明:::warning 用于具体风险或后果:::details 用于折叠内容（模板、目录、趣事）:::tabs 用于校区区分
嵌套规则：外层 ::::tabs，内层 :::info，用不同数量的冒号区分
路径和标题
- 使用
→ 表示路径：信息门户→缴费平台
- 使用
《...》 表示官方通知标题
标点符号
- 使用半角括号
() 而非全角括号 （）
- 删除多余的句号（列表项末尾通常不需要句号）
- 使用中文标点（，。！？）而非英文标点（,!?）
引用和不确定性
需要引用：
- 规则、考试政策、处分、费用、官方流程、统计、历史事件
- 非官方评价（如商家口碑、服务质量）
不确定时：
- 使用脚注
[^n] 并标注来源
- 或使用 "通常"、"可能"、"以当年通知为准"
非官方信息：
- 保留实用性，但标注来源限制或不确定性
- 使用脚注
[^n] 标注来源（如贴吧帖子、社交媒体）
结构模式
页面拆分
- 当页面内容过多时，拆分为多个子页面
- 主页面只保留核心信息和链接
- 子页面存放详细内容
列表与表格
- 简单列表：3 项以下用无序列表
- 复杂列表：嵌套层级多或需要对比时，优先使用表格
- 表格适合：原因/方法对比、参数说明、多条件查询
- 简化列表：删除列表项中的详细描述，只保留核心信息
脚注处理
- 合并同一来源的多个脚注
- 脚注放在引用句末尾，不单独成段
- 删除仅作为"延伸阅读"的脚注
- 删除只是入口链接的脚注（如官网首页）
详情块使用
- 删除过于详细的
:::details 块（如租车指南、操作流程）
- 只保留核心信息，详细内容由用户自行查看官方文档
- 使用
:::info 替代 "简单理解" 段落
- 将视频（
<iframe>）放入 :::details 块中
- 将大量数据（如电话表格）放入
:::details 块中
<Note> 标签使用
- 将
<Note>需要验证</Note> 替换为脚注 [^n]，并添加来源
- 只有真正需要验证的内容才使用
<Note> 标签
校区处理
校区答案不同：
:::tabs key:campus
== 合肥校区
合肥校区的内容
== 宣城校区
宣城校区的内容
:::
合肥校区答案相同：
:::tabs key:campus
== 合肥校区
合肥校区的内容（屯溪路、翡翠湖、六安路相同）
== 宣城校区
宣城校区的内容
:::
校区顺序：合肥校区在前，宣城校区在后
最终检查清单
完成改写前检查：
详细参考
- 完整风格规则：
references/style-guide.md
- 改写模式和示例：
references/rewrite-patterns.md
