Wiki 撰写规范

能愿动词

为了避免歧义,本文使用了「能愿动词」,对应的解释如下:

  • 必须(Must) - 只能这样子做,请无条件遵循,没有别的选项;
  • 绝不(Must Not)- 严令禁止,在任何情况下都不能这样做;
  • 应该(Should) - 强烈建议这样做,但是不强求;
  • 不应该(Should Not) - 强烈建议不这样做,但是不强求;
  • 可以(May) - 选择性高一点,在这个文档内,此词语使用较少;

基础规范

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 自动生成

善用二级和三级标题,LearnKu 文章模块会自动为您生成 TOC,这会让文章结构更加清晰,如下:

file

2. 代码块

所有的代码块 应该 使用 代码高亮

3. 截屏

在涉及视图操作时,应该 合理利用截图来提高易读性。请阅读 一图胜过千言万语

制作截图时,遵循以下:

4. 步骤清晰

所有『操作步骤』类型的文章,都 必须 使用编号 来保证步骤清晰。

步骤鲜明的 TOC 例子:

file

5. 一题多解

一题多解指的是一个问题有多种解决方案的,必须## 方法一## 方法二 这种方式罗列。

例如:

## 问题说明

Laravel 中定义路由的方式有哪些?

## 方法一、闭包路由

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

## 方法二、控制器路由

.
.
.

## 方法三、视图路由

.
.
.

## 方法四、重定向路由

.
.
.

## 参考

- 文档链接...

6. 参考和引用

参考链接有两个作用:

  • 声明引用文章的链接,尊重内容原作者;
  • 提供给读者深入学习的链接。

应该 在 Wiki 文章末尾加上 ## 参考 区块,并罗列引用或者推荐的链接。

本文章首发在 LearnKu.com 网站上。
上一篇 下一篇
讨论数量: 0
发起讨论 只看当前版本


暂无话题~