提问的艺术

约 1153 字大约 4 分钟

2025-11-20

一、提问前必做准备（核心前提）

1.1 优先查阅官方文档

所有基础使用问题（安装部署、配置项含义、功能启用/禁用、常见报错处理等），均已在官方文档中详细说明。
提问前必须完整查阅相关模块文档，确认问题无对应解决方案后，再在群内提问。
文档地址：https://docs.mizuki.mysqil.com/

1.2 自行排查常见问题

对照文档逐步复现操作步骤，验证是否因自身配置遗漏、路径错误、环境不兼容导致问题。
常见排查方向：
- 环境依赖是否满足（Node.js 版本≥20、pnpm 版本≥9、Astro 版本≥5.12.8 等）；
- 配置文件语法是否正确（TypeScript 类型匹配、逗号遗漏、路径写法规范等）；
- 静态资源路径是否符合规则（public 目录资源需以 / 开头，src 目录资源无需 /）；
- 部署流程是否完整（构建命令执行、站点 URL 配置、权限设置等）。

1.3 确认问题未被重复提问

提问前可通过群聊搜索功能，查询是否有其他成员已提出同类问题及解决方案。
避免重复询问文档中已明确、或群内近期已解答过的内容。

二、提问格式与内容要求（清晰高效）

2.1 开篇声明查阅状态

提问开头需明确说明：「已查阅官方文档XX模块，未找到对应解决方案」，示例：
已查阅官方文档“音乐播放器配置”和“常见问题”模块，未找到 Meting API 地址失效的解决办法，想请教大家...

2.2 完整描述问题场景

说明使用场景：开发环境（本地/部署平台）、设备类型（桌面/移动端）、浏览器型号（如需）；
说明操作背景：正在配置的功能（如标签侧边栏、Twikoo 评论）、已完成的步骤（如修改 config.ts、部署 Vercel 等）。

2.3 详细说明问题现象

明确问题表现：功能未生效、页面报错、样式异常等；
提供关键信息：
- 报错信息：复制完整报错文本（控制台日志、页面提示）；
- 配置代码：粘贴相关配置片段（如 musicPlayerConfig、sidebarLayoutConfig 部分），隐藏敏感信息；
- 效果截图：样式异常、页面空白等可视化问题，需附上清晰截图（标注关键区域）。

2.4 示例：规范提问模板

【已查阅文档】配置日记页面图片时，图片无法显示
【场景】本地开发环境（pnpm dev），桌面端 Chrome 浏览器，配置 src/data/diary.ts 中的 images 字段
【操作步骤】
1. 将图片放入 public/images/diary/ 目录，文件名 test.webp；
2. 在日记对象中添加 images: ["images/diary/test.webp"]；
3. 启动开发服务器后，日记页面仅显示文字，图片显示破损图标。
【报错信息】控制台无报错，网络请求显示 404 Not Found
【相关代码】
{
  id: 3,
  content: "测试日记图片",
  date: "2025-01-20T15:00:00Z",
  images: ["images/diary/test.webp"] // 问题路径
}
【截图】[此处附上页面截图和文件目录截图]