mirror of
https://github.com/brain-hackers/README
synced 2025-01-09 04:50:04 +09:00
ルールを更新
parent
83459e59a2
commit
09fec60bed
23
Wikiの編集方法.md
23
Wikiの編集方法.md
@ -94,20 +94,21 @@ Wiki 全体で「ですます」の形で統一します。
|
||||
冗長な表現を組み込んでしまうことは多いので、極限まで削ります。
|
||||
「など」「いろいろ」「といった」「〇〇することができます」は使いがちですので特に気をつけましょう。
|
||||
|
||||
- 悪い例: このコマンドを使えば、Linux を起動することなどが可能です。
|
||||
- 良い例: このコマンドで、Linux を起動できます。
|
||||
:x: 悪い例: このコマンドを使えば、Linux を起動することなどが可能です。
|
||||
|
||||
:o: 良い例: このコマンドで、Linux を起動できます。
|
||||
|
||||
|
||||
### カッコは基本的に使わない
|
||||
どうしても必要な場合は、名詞の別名や補足といった1〜2単語で済む体言を入れるだけにします。
|
||||
|
||||
- 悪い例: Linux マシン(Ubuntu か Debian が入っていることが望ましい)を用意します。
|
||||
- 良い例: Ubuntu か Debian がインストールされた Linux マシンを用意します。
|
||||
:x: 悪い例: Linux マシン(Ubuntu か Debian が入っていることが望ましい)を用意します。
|
||||
|
||||
:o: 良い例: Ubuntu か Debian がインストールされた Linux マシンを用意します。
|
||||
|
||||
|
||||
### 箇条書きには句読点を入れない
|
||||
箇条書きは段落を表現する道具ではありません。よって、内容が極力短くなるようにしつつ、句読点を置かないようにします。
|
||||
ちなみに、このページの良い例悪い例の例示では例外的に句読点を使っています。通常は使わないようにしましょう。
|
||||
|
||||
|
||||
### 感情を排除する
|
||||
@ -157,6 +158,18 @@ git config --global core.autocrlf input
|
||||
- 節と節の間
|
||||
|
||||
|
||||
### 適切な空白を入れる
|
||||
プレーンテキスト以外の要素の前後に適切な空白がないと表示がおかしくなるケースがあります。この文書は GitHub での表示に限られるため空白がなくても大丈夫ですが、エディタでのシンタックスハイライトが上手くいかなくなることがありますので気をつけましょう。
|
||||
|
||||
:x: 悪い例1: `1.あいうえお`
|
||||
|
||||
:o: 良い例1: `1. あいうえお`
|
||||
|
||||
:x: 悪い例2: `` このコマンドには`-a`という引数を渡します。 ``
|
||||
|
||||
:o: 良い例2: `` このコマンドには `-a` という引数を渡します。 ``
|
||||
|
||||
|
||||
### コードスパンとコードブロックを使い分ける
|
||||
コードスパンとは、`` `ident` ``のように行の中に等幅で文字を入れるスパン要素を指します。
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user