所有收藏
教育材料
错误报告的格式
错误报告的格式

如何使用 Markdown(一种标记语言)使报告更易懂、更吸引人

Kostya avatar
作者:Kostya
一周前更新

格式化报告有时可以帮助读者更快地识别重要信息。特别是当您提交可用性报告时,例如在调查中回答多个问题时,如果您的报告格式化了,读者就能很容易地区分问题和答案以及标题。

我们的报告表单支持 Markdown(一种标记语言),可让您使用简单的语法来格式化文本。下面,我们列出了在我们平台上记录错误时最有用的 Markdown 语法。

粗体文字

要强调重要的单词或短语,可将其加粗。只需在重要部分前后加上两个星号即可。

示例

The product cannot be added to the cart. This problem affects any product in the webshop. **No products can be purchased.**

结果

The product cannot be added to the cart. This problem affects any product in the webshop. No products can be purchased.

斜体文字

将步骤中的按钮标签或链接名称斜体化,可以使它们比撇号或纯文本更容易理解。为此,请在要斜体化的部分前后添加单个星号或下划线。

示例

Step 3: Click on the button *Add to Cart*.
Step 4: Go to the cart via _Your Shopping Cart_ in the header navigation.

结果

Step 3: Click on the button Add to Cart.
Step 4: Go to the cart via Your Shopping Cart in the header navigation.

列表

您可以使用项目符号来罗列排名相同的信息,从而增强信息的结构性和可读性。

示例

- The user gets redirected back to the shopping cart.
- The shopping cart is suddenly empty; items have been removed.
- The layout of the shopping cart page is broken.

结果

横向规则

水平规则有助于将不同的信息彼此分开。例如,当要求您提供在客户网站上使用的凭证时,您可以将其添加到预期结果中的水平规则下方。要添加水平规则,请添加一个换行符和另一行三个破折号、星号或下划线。​

示例

[...] Therefore, the checkout cannot be completed.

---
User name: tester12345
Password: 112233

结果


标题

当您提交可用性建议并需要细分信息时,引入标题是一种解决方案。在标题前添加标签符号 (#) 可以放大标题;使用的标签越多,标题字体就会越小。由于使用 # 和 ## 会产生较大的标题,我们建议在我们平台上的报告中使用三个或更多的标签。

示例

### Survey
##### Question 1: Name three things that you liked most about the product.
[Answer question 1]

##### Question 2: Which prototype website do you find more intuitive? Justify your answer!
[Answer question 2]

结果


更多信息

更多语法和示例可在互联网上找到,例如本Markdown 指南。有些项目无法使用或不适合在我们的错误表单中使用。

这是否解答了您的问题?