LaTeX 提问技巧 与 MWE 示意

2019-08-02 18:53发布

演示文稿53.pngMinimum Work Example,“最小工作示例”。顾名思义,最小工作示例特点有三:

简短  不包含与问题无关的代码片段;

工作  能够独立运行于他人的电脑上,而不需要添加额外的代码;

示例  在他人计算机上的运行结果,能完整的再现你遇到的问题。


一、希望他人帮忙解决问题,首先要让他们理解你遇到了什么问题。因此示例必不可少。

二、如果提供的示例在他人的电脑上无法运行,那么他们也就没有办法知道你遇到了什么问题。所以提供的代码必须能够正常工作。

三、时间对于任何一个人都是- .笔宝贵的财富。如果提供的代码冗长,则回答者势必要话费大量时间阅读不必要的代码。这浪费了回答者的时间,也浪费了提问者的时间(等待时间更久),因此有必要让代码足够简短。


来自慕子  https://paste.ubuntu.com/p/VgZSN9q9PV/  :

提问时,请介绍前因后果,提供尽可能完整的信息。


一种提问模板:

 - 我在写自己的笔记/准备投稿/写学位论文

 - 我想实现 xx 功能/效果,现在是这么做的(提供 MWE)

 - 我期待的结果是(文字描述或示意图)

 - 目前实现的效果是(截图,圈出重点),和期待结果的差别在于

  (提供文字描述或截图)


如何提问,如何提供 MWE

1.   具体问题的提问,需要提供具体的例子。
1.1. 如果问题是无法编译,此条可略过

2.   对具体例子的要求
2.1. 应当是一个完整的、在你的电脑上能编译的 LaTeX 文档
     何为完整:以 \documentclass 开始,以 \end{document} 结束
2.2. 在你电脑上的编译结果,应当能复现你的问题,或体现你的需求
2.3. 与复现问题和体现需求无关的代码,如各种宏包的加载,应尽可能少
2.4. 完整、可复现、无关内容尽量少,这些构成了一个 MWE(minimal working
     example)的要素

3.   其他文件
     如果通过具体例子复现问题需要用到下列一项或多项,请把它们和 LaTeX 文档
     一起打包为 zip
3.1. 使用了网上下载来的模板,并且问题在换用标准文档类(推荐使用 article 
     或 book)后无法复现
3.2. 使用了图片文件
3.3. 使用了 bib 文件
3.4. 其他

4.   提供方式
4.1. 展示具体例子时,只接受文本,不接受截图和照片
     源码超过 10 行时,先贴到 https://paste.ubuntu.com ,然后把返回的
     链接发出来
4.2. 展示屏幕输出时(如 PDF 效果、报错信息、各种示意图等),只接受截图和屏
     幕录像,不接受照片
4.3. 展示非屏幕输出时(如书影),接受照片
请勿在公告评论里发布广告,否则拉黑账号
6条评论
Iydon
1楼 · 2019-11-09 15:38

在群里或者网络上收藏的一些[LaTeX图片](https://github.com/Iydon/tex/tree/master/source/_static/images), 欢迎补充.

frank.xin
2楼 · 2019-10-26 11:38

请问为什么无法修改头像?上传成功但是不会生效。

二十
3楼 · 2019-10-13 13:01

好的

林雨翔_leo
4楼 · 2019-09-23 02:18

为什么我不能赞楼上两位

兰铃
5楼 · 2019-08-26 20:42

应该在加一条: 1. 简单问题提问之前,确保仔细阅读了文档。 2. 非常规问题确保去搜索引擎搜索后,如stackoverflow或者tex.stackexchange.com,找不到解决方案再来提问。(其实提问的好多问题随便一搜索就有答案,都习惯当伸手党了)

registor
6楼 · 2019-08-01 08:47

提问时提供MWE是必须的,不能只考虑自己方便,要与人方便。

站内公告