% !TeX root = ../exam-zh-doc-basic.tex

\section{如何提问}

提问前做好准备可以更快得到帮助，也节省彼此的时间。

\subsection{提问前的自查清单}

在提问之前，请确认已完成以下步骤：

\begin{enumerate}
  \item 仔细阅读了本入门文档、尝试在详细文档中搜索
  \item 查阅了第6章 FAQ
  \item 在项目 Issues 中搜索过类似问题
  \item 尝试了 Google 或搜索引擎
  \item 尝试了最小可复现示例
\end{enumerate}


\subsection{提问模板}

使用以下模板可以让问题更清晰：

\subsubsection{编译错误类问题}

\begin{latexcode}
系统：macOS / Windows / Linux
TeX 发行版：TeX Live 2024
exam-zh 版本：v0.26

问题描述：
  我想实现...，但是出现了...

复现代码：
  \documentclass{exam-zh}
  \begin{document}
    ...（能重现问题的最简代码）
  \end{document}

错误信息：
  ...（复制粘贴完整的错误文本）

期望效果：
  我希望能...
\end{latexcode}

\subsubsection{功能咨询类问题}

\begin{latexcode}
系统：macOS / Windows / Linux
exam-zh 版本：v0.26

问题描述：
  我想实现...（描述需求）

当前尝试：
  我尝试了...，但是...

期望效果：
  我希望能...
\end{latexcode}


\subsection{注意事项}

\begin{enumerate}
  \item \textbf{最小可复现示例}
    \begin{itemize}
      \item 删除不相关的代码
      \item 保留能重现问题的最少代码
      \item 确保代码能独立编译
    \end{itemize}

  \item \textbf{完整错误信息}
    \begin{itemize}
      \item 复制粘贴错误文本（不要截图）
      \item 包含完整的错误堆栈
      \item \textcolor{red}{\textbf{不要用手机拍照}}
    \end{itemize}

  \item \textbf{清晰的描述}
    \begin{itemize}
      \item 说明你想做什么
      \item 说明实际发生了什么
      \item 说明期望的结果
    \end{itemize}

  \item \textbf{系统信息}
    \begin{itemize}
      \item 操作系统
      \item \TeX{} 发行版版本
      \item exam-zh 版本
    \end{itemize}
\end{enumerate}


\subsection{提问渠道}

\begin{description}
  \item[Issues（推荐）]
    \begin{itemize}
      \item Gitee: \url{https://gitee.com/xkwxdyy/exam-zh/issues}
      \item GitHub: \url{https://github.com/xkwxdyy/exam-zh/issues}
      \item 优点：记录完整，可搜索，方便他人参考
    \end{itemize}

  \item[QQ 群] 652500180
    \begin{itemize}
      \item 优点：实时交流，快速响应
      \item 缺点：讨论容易淹没，不便搜索
    \end{itemize}
\end{description}


\subsection{延伸阅读}

想了解更多提问技巧，请阅读：

\begin{itemize}
  \item 完整文档中的"提问的智慧"章节
  \item \href{https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way}{《提问的智慧》}
\end{itemize}
