Wiki 撰寫規范

能愿動詞

為了避免歧義，本文使用了「能愿動詞」，對應的解釋如下：

• 必須（Must） - 只能這樣子做，請無條件遵循，沒有別的選項；
• 絕不（Must Not）- 嚴令禁止，在任何情況下都不能這樣做；
• 應該（Should） - 強烈建議這樣做，但是不強求；
• 不應該（Should Not） - 強烈建議不這樣做，但是不強求；
• 可以（May） - 選擇性高一點，在這個文檔內，此詞語使用較少；

基礎規范

• 必須 使用 Markdown 語法 撰寫；
• 必須 遵循 中文文案排版規范；

1. 標題

規范：絕不 在 Wiki 里寫入『一級標題』，標題的 Markdown 標題語法 請見。

錯誤的例子：

# Laravel 中定義路由的方式有哪些？

## 可以使用閉包：

```php
Route::get('hello', function () {
    return 'Hello World';
});
```
.
.
.

# 參考

- 鏈接...

正確的例子：

## 問題說明

Laravel 中定義路由的方式有哪些？

## 方法一、使用閉包

```php
Route::get('hello', function () {
    return 'Hello World';
});
```
.
.
.

## 參考

- 鏈接...

所有內容塊 必須 以『二級標題』開始，絕不跳過選擇『三級標題』，正確的例子如上，錯誤的例子如下：

### Laravel 中定義路由的方式有哪些？

### 可以使用閉包：

```php
Route::get('hello', function () {
    return 'Hello World';
});
```
.
.
.

### 參考

- 鏈接...

TOC 自動生成

善用二級和三級標題，社區使用指南 文章模塊會自動為您生成 TOC，這會讓文章結構更加清晰，如下：

2. 代碼塊

所有的代碼塊 應該 使用代碼高亮。

3. 截屏

在涉及視圖操作時，應該 合理利用截圖來提高易讀性。請閱讀一圖勝過千言萬語。

制作截圖時，遵循以下：

• 必須 確保 截屏要釋義 ；
• 必須 確保 截屏要干凈 ；
• 必須 確保 尺寸合理 。

4. 步驟清晰

所有『操作步驟』類型的文章，都 必須 使用編號 來保證步驟清晰。

步驟鮮明的 TOC 例子：

5. 一題多解

一題多解指的是一個問題有多種解決方案的，必須 以 ## 方法一、## 方法二 這種方式羅列。

例如：

## 問題說明

Laravel 中定義路由的方式有哪些？

## 方法一、閉包路由

```php
Route::get('hello', function () {
    return 'Hello World';
});
```

## 方法二、控制器路由

.
.
.

## 方法三、視圖路由

.
.
.

## 方法四、重定向路由

.
.
.

## 參考

- 文檔鏈接...

6. 參考和引用

參考鏈接有兩個作用：

• 聲明引用文章的鏈接，尊重內容原作者；
• 提供給讀者深入學習的鏈接。

應該 在 Wiki 文章末尾加上 ## 參考 區塊，并羅列引用或者推薦的鏈接。