Skip to content

Commit 2c9716e

Browse files
committed
docs(readme): add description
1 parent 2848473 commit 2c9716e

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,20 +32,23 @@ textlint --preset ja-technical-writing README.md
3232
## ルール一覧
3333

3434
### 1文の長さは90文字以下とする
35+
長過ぎる文は読みにくさに繋がるため適切な単位で文を区切ってください。
3536
https://github.com/azu/textlint-rule-sentence-length
3637

3738
"sentence-length": {
3839
max: 90
3940
},
4041
41-
### コンマは1文中に3つまで
42+
### カンマは1文中に3つまで
43+
カンマ(,)の多用は、文が長くなっている可能性があります。
4244
https://github.com/azu/textlint-rule-max-comma
4345

4446
"max-comma": {
4547
max: 3
4648
},
4749
4850
### 読点は1文中に3つまで
51+
読点(、)の多用は、文が長くなっている可能性があります。
4952
https://github.com/azu/textlint-rule-max-ten
5053

5154
"max-ten": {
@@ -71,6 +74,8 @@ https://github.com/azu/textlint-rule-preset-JTF-style
7174
"arabic-kanji-numbers": true,
7275

7376
### 「ですます調」、「である調」を統一します
77+
文体は見出し、本文、箇条書きの中では統一した表記にします。
78+
7479
- 見出しは自動
7580
- 本文はですます調
7681
- 箇条書きはである調
@@ -87,6 +92,7 @@ https://github.com/azu/textlint-rule-no-mix-dearu-desumasu
8792

8893

8994
### 文末の句点記号として「。」を使います
95+
文末には「。」を使い文を区切ります。
9096
https://github.com/textlint-ja/textlint-rule-ja-no-mixed-period
9197

9298
"ja-no-mixed-period": {
@@ -104,6 +110,8 @@ https://github.com/azu/textlint-rule-no-dropping-the-ra
104110
"no-dropping-the-ra": true,
105111
106112
### 同じ表現から文を開始しすぎない
113+
同じ表現から文を開始している場合、文の間で矛盾が発生している場合があります。
114+
箇条書きなど、同じ表現から開始したいは[textlint-filter-rule-comments](https://github.com/textlint/textlint-filter-rule-comments "textlint-filter-rule-comments")を使い回避してください。
107115
https://github.com/azu/textlint-rule-no-start-duplicated-conjunction
108116

109117
"no-start-duplicated-conjunction": {
@@ -135,12 +143,14 @@ https://github.com/azu/textlint-rule-no-nfd
135143

136144
"no-nfd": true,
137145
138-
### 感嘆符!!、疑問符??を使用しない
146+
### 感嘆符!!、感嘆符??を使用しない
147+
特定の感嘆符または感嘆符を使用する場合は、オプションで許可して利用してください。
139148
https://github.com/azu/textlint-rule-no-exclamation-question-mark
140149

141150
"no-exclamation-question-mark": true,
142151
143152
### 半角カナを使用しない
153+
全角カタカナを使用してください。
144154
https://github.com/azu/textlint-rule-no-hankaku-kana
145155

146156
"no-hankaku-kana": true,
@@ -153,11 +163,14 @@ https://github.com/textlint-ja/textlint-rule-ja-no-weak-phrase
153163
"ja-no-weak-phrase": true,
154164
155165
### 同一の単語を間違えて連続しているのをチェックする
166+
同一の単語(形態素解析したtoken)が連続している場合は誤字の可能性があります。
167+
誤字ではない場合は、[Issue報告](https://github.com/textlint-ja/textlint-rule-ja-no-successive-word/issues/new)してください。
156168
https://github.com/textlint-ja/textlint-rule-ja-no-successive-word
157169

158170
"ja-no-successive-word": true,
159171
160172
### よくある日本語の誤用をチェックする
173+
日本語や技術表現における漢字の誤用などをチェックするルールです。
161174
https://github.com/textlint-ja/textlint-rule-ja-no-abusage
162175

163176
"ja-no-abusage": true

0 commit comments

Comments
 (0)