Skip to content

Commit 77769f3

Browse files
committed
docs(readme): update
1 parent 2c9716e commit 77769f3

File tree

1 file changed

+41
-23
lines changed

1 file changed

+41
-23
lines changed

README.md

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

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

3840
"sentence-length": {
3941
max: 90
4042
},
4143
4244
### カンマは1文中に3つまで
45+
> https://github.com/azu/textlint-rule-max-comma
46+
4347
カンマ(,)の多用は、文が長くなっている可能性があります。
44-
https://github.com/azu/textlint-rule-max-comma
4548

4649
"max-comma": {
4750
max: 3
4851
},
4952
5053
### 読点は1文中に3つまで
54+
> https://github.com/azu/textlint-rule-max-ten
55+
5156
読点(、)の多用は、文が長くなっている可能性があります。
52-
https://github.com/azu/textlint-rule-max-ten
5357

5458
"max-ten": {
5559
max: 3
5660
},
5761
5862
### 連続できる最大の漢字長は5文字まで
63+
> https://github.com/azu/textlint-rule-max-kanji-continuous-len
64+
5965
漢字同士が連続していると読みにくさにつながります。
60-
https://github.com/azu/textlint-rule-max-kanji-continuous-len
6166

6267
"max-kanji-continuous-len": {
6368
max: 5
6469
},
6570
6671
### 漢数字と算用数字を使い分けます
67-
- 数量を表現し、数を数えられるものは算用数字を使用します。
68-
- 任意の数に置き換えても通用する語句がこれに該当します。
69-
- 慣用的表現、熟語、概数、固有名詞、副詞など、漢数字を使用することが一般的な語句では漢数字を使います。
72+
> https://github.com/azu/textlint-rule-preset-JTF-style
7073
71-
https://github.com/azu/textlint-rule-preset-JTF-style
74+
数量を表現し、数を数えられるものは算用数字を使用します。任意の数に置き換えても通用する語句がこれに該当します。
7275

76+
慣用的表現、熟語、概数、固有名詞、副詞など、漢数字を使用することが一般的な語句では漢数字を使います。
7377

7478
"arabic-kanji-numbers": true,
7579

7680
### 「ですます調」、「である調」を統一します
77-
文体は見出し、本文、箇条書きの中では統一した表記にします。
81+
> https://github.com/azu/textlint-rule-no-mix-dearu-desumasu
7882
7983
- 見出しは自動
8084
- 本文はですます調
8185
- 箇条書きはである調
8286

83-
https://github.com/azu/textlint-rule-no-mix-dearu-desumasu
84-
87+
文体は見出し、本文、箇条書きの中では統一した表記にします。
8588

8689
"no-mix-dearu-desumasu": {
8790
"preferInHeader": "",
@@ -92,86 +95,101 @@ https://github.com/azu/textlint-rule-no-mix-dearu-desumasu
9295

9396

9497
### 文末の句点記号として「。」を使います
98+
> https://github.com/textlint-ja/textlint-rule-ja-no-mixed-period
99+
95100
文末には「。」を使い文を区切ります。
96-
https://github.com/textlint-ja/textlint-rule-ja-no-mixed-period
101+
97102

98103
"ja-no-mixed-period": {
99104
"periodMark": "。"
100105
},
101106
102107
### 二重否定は使用しない
103-
https://github.com/azu/textlint-rule-no-double-negative-ja
108+
> https://github.com/azu/textlint-rule-no-double-negative-ja
104109
105110
"no-double-negative-ja": true,
106111
107112
### ら抜き言葉を使用しない
108-
https://github.com/azu/textlint-rule-no-dropping-the-ra
113+
> https://github.com/azu/textlint-rule-no-dropping-the-ra
109114
110115
"no-dropping-the-ra": true,
111116
112117
### 同じ表現から文を開始しすぎない
118+
> https://github.com/azu/textlint-rule-no-start-duplicated-conjunction
119+
113120
同じ表現から文を開始している場合、文の間で矛盾が発生している場合があります。
121+
114122
箇条書きなど、同じ表現から開始したいは[textlint-filter-rule-comments](https://github.com/textlint/textlint-filter-rule-comments "textlint-filter-rule-comments")を使い回避してください。
115-
https://github.com/azu/textlint-rule-no-start-duplicated-conjunction
116123

117124
"no-start-duplicated-conjunction": {
118125
"interval": 2
119126
},
120127

121128
122129
### 逆接の接続助詞「が」を連続して使用しない
130+
> https://github.com/takahashim/textlint-rule-no-doubled-conjunctive-particle-ga
131+
123132
逆接の接続助詞「が」は、特に否定の意味ではなくても安易に使われてしまいがちです。
133+
124134
同一文中に複数回出現していないかをチェックします。
125-
https://github.com/takahashim/textlint-rule-no-doubled-conjunctive-particle-ga
126135

127136
"no-doubled-conjunctive-particle-ga": true,
128137
129138
### 同じ接続詞を連続して使用しない
130-
https://github.com/takahashim/textlint-rule-no-doubled-conjunction
139+
> https://github.com/takahashim/textlint-rule-no-doubled-conjunction
131140
132141
"no-doubled-conjunction": true,
133142
134143
### 同じ助詞を連続して使用しない
144+
> https://github.com/azu/textlint-rule-no-doubled-joshi
135145
136146
"no-doubled-joshi": {
137147
"min_interval": 1
138148
},
139149

140150
### UTF8-MAC 濁点を使用しない
151+
> https://github.com/azu/textlint-rule-no-nfd
152+
141153
文章中にUTF8-MAC 濁点は不要です。
142-
https://github.com/azu/textlint-rule-no-nfd
154+
ファイルからコピー&ペーストした文字である場合があります。
143155

144156
"no-nfd": true,
145157
146158
### 感嘆符!!、感嘆符??を使用しない
159+
> https://github.com/azu/textlint-rule-no-exclamation-question-mark
160+
147161
特定の感嘆符または感嘆符を使用する場合は、オプションで許可して利用してください。
148-
https://github.com/azu/textlint-rule-no-exclamation-question-mark
149162

150163
"no-exclamation-question-mark": true,
151164
152165
### 半角カナを使用しない
166+
> https://github.com/azu/textlint-rule-no-hankaku-kana
167+
153168
全角カタカナを使用してください。
154-
https://github.com/azu/textlint-rule-no-hankaku-kana
155169

156170
"no-hankaku-kana": true,
157171
158172
### 弱い日本語表現の利用を使用しない
173+
> https://github.com/textlint-ja/textlint-rule-ja-no-weak-phrase
174+
159175
`〜かもしれない` 等の弱い表現を使用しない。
160-
https://github.com/textlint-ja/textlint-rule-ja-no-weak-phrase
161176

162177

163178
"ja-no-weak-phrase": true,
164179
165180
### 同一の単語を間違えて連続しているのをチェックする
181+
> https://github.com/textlint-ja/textlint-rule-ja-no-successive-word
182+
166183
同一の単語(形態素解析したtoken)が連続している場合は誤字の可能性があります。
184+
167185
誤字ではない場合は、[Issue報告](https://github.com/textlint-ja/textlint-rule-ja-no-successive-word/issues/new)してください。
168-
https://github.com/textlint-ja/textlint-rule-ja-no-successive-word
169186

170187
"ja-no-successive-word": true,
171188
172189
### よくある日本語の誤用をチェックする
190+
> https://github.com/textlint-ja/textlint-rule-ja-no-abusage
191+
173192
日本語や技術表現における漢字の誤用などをチェックするルールです。
174-
https://github.com/textlint-ja/textlint-rule-ja-no-abusage
175193

176194
"ja-no-abusage": true
177195

0 commit comments

Comments
 (0)