brain-hackers_pepepper-mirror/README
1
0
Fork 0
mirror of https://github.com/brain-hackers/README synced 2024-12-23 04:30:03 +09:00
Code Issues Projects Releases Wiki Activity

ルールを更新

Takumi Sueda 2021-02-01 12:27:16 +09:00
parent 09fec60bed
commit 8dc3402ae5
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Wikiの編集方法.md

@ -11,6 +11,7 @@
- [記述ルール](#%E8%A8%98%E8%BF%B0%E3%83%AB%E3%83%BC%E3%83%AB)
- [文体](#%E6%96%87%E4%BD%93)
- [「ですます」と「だ・である」は統一する](#%E3%81%A7%E3%81%99%E3%81%BE%E3%81%99%E3%81%A8%E3%81%A0%E3%83%BB%E3%81%A7%E3%81%82%E3%82%8B%E3%81%AF%E7%B5%B1%E4%B8%80%E3%81%99%E3%82%8B)
- [依頼する時はできるだけ「します」で締める](#%E4%BE%9D%E9%A0%BC%E3%81%99%E3%82%8B%E6%99%82%E3%81%AF%E3%81%A7%E3%81%8D%E3%82%8B%E3%81%A0%E3%81%91%E3%81%97%E3%81%BE%E3%81%99%E3%81%A7%E7%B7%A0%E3%82%81%E3%82%8B)
- [繰り返しや冗長な表現をなくす](#%E7%B9%B0%E3%82%8A%E8%BF%94%E3%81%97%E3%82%84%E5%86%97%E9%95%B7%E3%81%AA%E8%A1%A8%E7%8F%BE%E3%82%92%E3%81%AA%E3%81%8F%E3%81%99)
- [カッコは基本的に使わない](#%E3%82%AB%E3%83%83%E3%82%B3%E3%81%AF%E5%9F%BA%E6%9C%AC%E7%9A%84%E3%81%AB%E4%BD%BF%E3%82%8F%E3%81%AA%E3%81%84)
- [箇条書きには句読点を入れない](#%E7%AE%87%E6%9D%A1%E6%9B%B8%E3%81%8D%E3%81%AB%E3%81%AF%E5%8F%A5%E8%AA%AD%E7%82%B9%E3%82%92%E5%85%A5%E3%82%8C%E3%81%AA%E3%81%84)
@ -20,6 +21,7 @@
- [必ずプレビューして確認する](#%E5%BF%85%E3%81%9A%E3%83%97%E3%83%AC%E3%83%93%E3%83%A5%E3%83%BC%E3%81%97%E3%81%A6%E7%A2%BA%E8%AA%8D%E3%81%99%E3%82%8B)
- [改行コードは LF に統一する](#%E6%94%B9%E8%A1%8C%E3%82%B3%E3%83%BC%E3%83%89%E3%81%AF-lf-%E3%81%AB%E7%B5%B1%E4%B8%80%E3%81%99%E3%82%8B)
- [適切な空行を入れる](#%E9%81%A9%E5%88%87%E3%81%AA%E7%A9%BA%E8%A1%8C%E3%82%92%E5%85%A5%E3%82%8C%E3%82%8B)
- [適切な空白を入れる](#%E9%81%A9%E5%88%87%E3%81%AA%E7%A9%BA%E7%99%BD%E3%82%92%E5%85%A5%E3%82%8C%E3%82%8B)
- [コードスパンとコードブロックを使い分ける](#%E3%82%B3%E3%83%BC%E3%83%89%E3%82%B9%E3%83%91%E3%83%B3%E3%81%A8%E3%82%B3%E3%83%BC%E3%83%89%E3%83%96%E3%83%AD%E3%83%83%E3%82%AF%E3%82%92%E4%BD%BF%E3%81%84%E5%88%86%E3%81%91%E3%82%8B)
- [明示的改行はバックスラッシュで行う](#%E6%98%8E%E7%A4%BA%E7%9A%84%E6%94%B9%E8%A1%8C%E3%81%AF%E3%83%90%E3%83%83%E3%82%AF%E3%82%B9%E3%83%A9%E3%83%83%E3%82%B7%E3%83%A5%E3%81%A7%E8%A1%8C%E3%81%86)
@ -90,6 +92,9 @@ Wiki の体裁について以下にルールを列挙します。コミットの
Wiki 全体で「ですます」の形で統一します。
### 依頼する時はできるだけ「します」で締める
「〇〇してください」は長いので、「します」で極力統一します。不自然に映る場合は「してください」や「しましょう」を使っても OK です。この文書でも実際にどちらも使用しています。
### 繰り返しや冗長な表現をなくす
冗長な表現を組み込んでしまうことは多いので、極限まで削ります。
「など」「いろいろ」「といった」「〇〇することができます」は使いがちですので特に気をつけましょう。
@ -181,7 +186,7 @@ echo foo
のように新しい段落で等幅に文字を入れるブロック要素を指します。
コードスパンはコードの識別子やコマンド名の例示に使い、コードブロックは複数行のプログラムや完全なコマンド（実行可能な文字列）の例示に使用します。
コードスパンはコードの識別子や短いコマンドの例示に使い、コードブロックは複数行のプログラムや長いコマンドの例示に使用します。
例1: `ls` コマンドには `-l` というオプションがあります。