textlint-ja/textlint-rule-preset-ja-technical-writing

代码动态 Issues8 合并请求57 版本3

textlint-ja/textlint-rule-preset-ja-technical-writing · 文件下载 ZIP

文件最后提交记录最后更新时间

.gitignore2K

CHANGELOG.md6K

LICENSE1K

package-lock.json219K

package.json2K

README.md23K

renovate.json34

README.md

以下内容由 AI 翻译，如有问题请点此提交 issue 反馈

textlint-rule-preset-ja-technical-writing

面向技术文档的textlint规则预设。由于默认值整体设置得较为严格，因此需要根据文章调整设置值。

また、連続できる最大の漢字長は6文字までのように文章全体として例外が必ず出てくるルールもデフォルトで入っています。ルールによってはallowオプションで例外を規定できるようになっているため、例外を明示しつつ利用することを想定しています。

请参阅假设配合使用的 filter 规则（可明确指定例外）。

Online Demo

您可以通过以下 URL 在浏览器中测试规则的行为。

https://textlint-ja.github.io/textlint-rule-preset-ja-technical-writing/

安装

可以使用 npm](https://www.npmjs.com/) 命令进行安装。

npm install textlint-rule-preset-ja-technical-writing

安定版は、半年(1月と7月)に一度更新されます。

通过添加如下@next，您可以安装并试用下一版本。稳定版与下一版本的差异可在Version Packages的PR中查看。

npm install textlint-rule-preset-ja-technical-writing@next

もし、次期バージョンを利用してみて問題があった場合は、コメントでお知らせください。

用法

通过 .textlintrc.json（推荐）

{
  "rules": {
    "preset-ja-technical-writing": true
  }
}

通过 CLI

textlint --preset ja-technical-writing README.md

ルールの設定方法

如下所示 "preset-ja-technical-writing" 通过指定以下各个选项值，可以更改设置。各规则可配置的选项，请参阅各规则的 README。

{
  "rules": {
    "preset-ja-technical-writing": {
      "max": 120,
      "no-mix-dearu-desumasu": false
    }
  }
}

此外，关于规则的设置方法，请参阅textlint的文档。

ルール一覧

1 文章长度不超过 100 字

1文の長さは100文字以下とする

https://github.com/textlint-rule/textlint-rule-sentence-length

長過ぎる文は読みにくさに繋がるため、適切な長さで文を句点（。）などで区切ってください。厳しめの設定にしたい場合は90文字を推奨しています。

デフォルト設定は次の通りです。

{
  "rules": {
    "preset-ja-technical-writing": {
      "sentence-length": {
        "max": 100
      }
    }
  }
}

過去の設定の履歴は以下のようになっています。

バージョン3.0.0+: 100文字以下
バージョン2.0.0以下: 90文字以下

カンマは1文中に3つまで

https://github.com/textlint-rule/textlint-rule-max-comma

カンマ（,）の多用は、文が長くなっている可能性があります。 1文が長くなると読みにくなっている可能性があるため適切な長さで文を句点（。）などで区切ってください。

デフォルト設定は次の通りです。

{
  "rules": {
    "preset-ja-technical-writing": {
      "max-comma": {
        "max": 3
      }
    }
  }
}

読点は1文中に3つまで

https://github.com/textlint-ja/textlint-rule-max-ten

読点（、）の多用は、1文が長くなっている可能性があります。 1文が長くなると読みにくなっている可能性があるため、適切な長さで文を句点（。）などで区切ってください。

デフォルト設定は次の通りです。

{
  "rules": {
    "preset-ja-technical-writing": {
      "max-ten": {
        "max": 3
      }
    }
  }
}

連続できる最大の漢字長は6文字まで

https://github.com/textlint-ja/textlint-rule-max-kanji-continuous-len

漢字同士が連続していると読みにくさにつながります。デフォルトでは連続する漢字は、6文字までとしています。

6文字以上の固有名詞は allow オプションに記述して回避できます。

デフォルト設定は次の通りです。

{
  "rules": {
    "preset-ja-technical-writing": {
      "max-kanji-continuous-len": {
        "max": 6,
        "allow": []
      }
    }
  }
}

漢数字と算用数字を使い分けます

https://github.com/textlint-ja/textlint-rule-preset-JTF-style

数量を表現し、数を数えられるものは算用数字を使用します。任意の数に置き換えても通用する語句がこれに該当します。

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

デフォルト設定は次の通りです。

{
  "rules": {
    "preset-ja-technical-writing": {
      "arabic-kanji-numbers": true
    }
  }
}

「ですます調」、「である調」を統一します

https://github.com/textlint-ja/textlint-rule-no-mix-dearu-desumasu

文章の「ですます調」、「である調」を統一してください。文体は見出し、本文、箇条書きの中で、それぞれ統一した表記にします。

デフォルト設定は次の通りです。

見出しは自動
本文はですます調
箇条書きはである調

{
  "rules": {
    "preset-ja-technical-writing": {
      "no-mix-dearu-desumasu": {
        "preferInHeader": "",
        "preferInBody": "ですます",
        "preferInList": "である",
        "strict": false
      }
    }
  }
}

文末の句点記号として「。」を使います

https://github.com/textlint-ja/textlint-rule-ja-no-mixed-period

文末には「。」を使い文を区切ります。

「。」のつけ忘れのチェックや「:」で文を終わらせないようにします。

デフォルト設定は次の通りです。

{
  "rules": {
    "preset-ja-technical-writing": {
      "ja-no-mixed-period": {
        "periodMark": "。"
      }
    }
  }
}

二重否定は使用しない

https://github.com/textlint-ja/textlint-rule-no-double-negative-ja

二重否定は文章を読みにくくするため、使用しないようにします。

デフォルト設定は次の通りです。

{
  "rules": {
    "preset-ja-technical-writing": {
      "no-double-negative-ja": true
    }
  }
}

ら抜き言葉を使用しない

https://github.com/textlint-ja/textlint-rule-no-dropping-the-ra

ら抜き言葉は話し言葉のため、書き言葉である文章では使用しないようにします。

デフォルト設定は次の通りです。

{
  "rules": {
    "preset-ja-technical-writing": {
      "no-dropping-the-ra": true
    }
  }
}

逆接の接続助詞「が」を連続して使用しない

https://github.com/textlint-ja/textlint-rule-no-doubled-conjunctive-particle-ga

逆接の接続助詞「が」は、特に否定の意味ではなくても安易に使われてしまいがちです。

同一文中に「が」が複数回出現していないかをチェックします。

デフォルト設定は次の通りです。

{
  "rules": {
    "preset-ja-technical-writing": {
      "no-doubled-conjunctive-particle-ga": true
    }
  }
}

同じ接続詞を連続して使用しない

https://github.com/textlint-ja/textlint-rule-no-doubled-conjunction

「しかし、〜。しかし、〜」のように同じ接続詞が連続すると、文章が読みにくくなります。同じ接続詞が連続して使用されていないかをチェックします。

デフォルト設定は次の通りです。

{
  "rules": {
    "preset-ja-technical-writing": {
      "no-doubled-conjunction": true
    }
  }
}

同じ助詞を連続して使用しない

https://github.com/textlint-ja/textlint-rule-no-doubled-joshi

文中で同じ助詞が連続すると文章が読みにくくなります。 1つの文中に同じ助詞が連続して出てくるのをチェックします。

修正方法としては、次のようなものがあります。

助詞の書き間違いなので、別の助詞に置き換える
- 例) 私は彼は好きだ → 私は彼が好きだ
複数のことを1つの文で書いている可能性があるため、助詞が連続している文を分割する
- 1文でまとめようとして、無理やり助詞で文を繋いでいる可能性があります
- 文自体を分けることで、同じ助詞が連続していることがなくなります
- 例) https://github.com/asciidwango/js-primer/pull/1598#discussion_r1110939474
助詞で無理やり文を繋げている可能性があるので、文の中で順番を入れ替える
- 助詞で文の中身を無理やり繋げようとしていて、使える助詞の選択肢が狭くなっている可能性があります
- 文の流れを箇条書きなどにして整理してみてください
- 例) https://github.com/asciidwango/js-primer/pull/1594#discussion_r1110973573
助詞が不要なら削除して、文を簡潔にする
- "実際に" などのように強調的な言葉を削除することで、助詞が不要になる可能性があります
- 技術文書では簡潔な文章を心がけることが多いため、強調的な単語自体を削除することもあります

由于例外](https://github.com/textlint-ja/textlint-rule-no-doubled-joshi#%E4%BE%8B%E5%A4%96)较多，详情请参阅[textlint-rule-no-doubled-joshi](https://github.com/textlint-ja/textlint-rule-no-doubled-joshi)的README。此外，通过allow选项，可以允许特定的助词连续出现。

文自体を直す余地がない場合は、コメントなどを使ってエラーを無視してください。

忽略文本 · textlint

デフォルト設定は次の通りです。

{
  "rules": {
    "preset-ja-technical-writing": {
      "no-doubled-joshi": {
        "min_interval": 1
      }
    }
  }
}

不使用 UTF8-MAC 浊点

https://github.com/textlint-ja/textlint-rule-no-nfd

文章中不使用 UTF8-MAC 浊点。这些字符可能是从文件中复制并粘贴的。

デフォルト設定は次の通りです。

{
  "rules": {
    "preset-ja-technical-writing": {
      "no-nfd": true
    }
  }
}

不必要な制御文字を使用しない

https://github.com/textlint-rule/textlint-rule-no-invalid-control-character

改行(\n)やタブ(\t)以外の制御文字が文章に入るのを防止します。

不必要な制御文字は文字化けの原因となるため、使用しないようにします。

デフォルト設定は次の通りです。

{
  "rules": {
    "preset-ja-technical-writing": {
      "no-invalid-control-character": true
    }
  }
}

不必要なゼロ幅スペースを使用しない

https://github.com/textlint-rule/textlint-rule-no-zero-width-spaces

ゼロ幅スペース（\u200b）が文章に入るのを防止します。

デフォルト設定は次の通りです。

{
  "rules": {
    "preset-ja-technical-writing": {
      "no-zero-width-spaces": true
    }
  }
}

感嘆符!！、疑問符?？を使用しない

https://github.com/textlint-rule/textlint-rule-no-exclamation-question-mark

技術文書では、感嘆符（!！）、疑問符（?？）は基本的には使用しないでください。特定の感嘆符や疑問符を使用する場合は、オプションで許可するか、コメントなどで例外として無視してください。

デフォルト設定は次の通りです。

{
  "rules": {
    "preset-ja-technical-writing": {
      "no-exclamation-question-mark": true
    }
  }
}

半角カナを使用しない

https://github.com/textlint-ja/textlint-rule-no-hankaku-kana

全角カタカナを使用してください。

デフォルト設定は次の通りです。

{
  "rules": {
    "preset-ja-technical-writing": {
      "no-hankaku-kana": true
    }
  }
}

弱い日本語表現の利用を使用しない

https://github.com/textlint-ja/textlint-rule-ja-no-weak-phrase

〜かもしれない や 〜と思います 等の弱い表現を使用しないでください。技術文書で曖昧な表現を避けるようにするためのルールです。

デフォルト設定は次の通りです。

{
  "rules": {
    "preset-ja-technical-writing": {
      "ja-no-weak-phrase": true
    }
  }
}

同一の単語を間違えて連続しているのをチェックする

https://github.com/textlint-ja/textlint-rule-ja-no-successive-word

如果同一个单词（经过形态素解析的 token）连续出现，则可能是输入错误或拼写错误。

如果不是拼写错误，请报告 Issue。

デフォルト設定は次の通りです。

{
  "rules": {
    "preset-ja-technical-writing": {
      "ja-no-successive-word": true
    }
  }
}

よくある日本語の誤用をチェックする

https://github.com/textlint-ja/textlint-rule-ja-no-abusage

日本語や技術表現における漢字の誤用などをチェックするルールです。

デフォルト設定は次の通りです。

{
  "rules": {
    "preset-ja-technical-writing": {
      "ja-no-abusage": true
    }
  }
}

冗長な表現をチェックする

https://github.com/textlint-ja/textlint-rule-ja-no-redundant-expression

冗長な表現とは、その文から省いても意味が通じるような表現を示しています。 "することができる"という冗長な表現を"できる"にするといったルールです。

デフォルト設定は次の通りです。

{
  "rules": {
    "preset-ja-technical-writing": {
      "ja-no-redundant-expression": true
    }
  }
}

入力ミスで発生する不自然なアルファベットをチェックする

https://github.com/textlint-ja/textlint-rule-ja-unnatural-alphabet

リイr−ス 检查混入日语中的因 IME 输入错误而产生的不自然英文字母。

デフォルト設定は次の通りです。

{
  "rules": {
    "preset-ja-technical-writing": {
      "ja-unnatural-alphabet": true
    }
  }
}

対になっていない括弧をチェックする

https://github.com/textlint-rule/textlint-rule-no-unmatched-pair

1文中で対になっていない括弧チェックします。 (に対応する)がない場合や、[に対応する]がない場合などをチェックします。

デフォルト設定は次の通りです。

{
  "rules": {
    "preset-ja-technical-writing": {
      "no-unmatched-pair": true
    }
  }
}

变更日志

参见发布页面。

语义化版本策略

次のルールでバージョンが更新されます。

Patch 版本发布
- 各规则的 Bug 修复（朝减少警告的方向修复）
- 文档的改进
- 内部变更（如重构或测试改进等）
- 发布失败时的重新发布
Minor 版本发布
- 各规则的 Bug 修复（朝增加警告的方向修复）
- 新选项的添加
- 现有规则的弃用
Major 版本发布
- 向预设中添加规则
- 从预设中删除规则
- 现有选项值的变更

更新内容请参考Releases page。

Release Flow

创建下一个 Major 版本的 Issue，并在 Issue 中编写 CHANGELOG
Pull Request 由 renovatebot 发出，因此进行合并
每半年会创建用于发布的 Issue，请确认并合并用于发布的 PR
发布完成后关闭 Issue

ルールの利用者

このプリセットを利用しているユーザーです。

我们也欢迎向用户列表提交 PR。

Community

请在以下 Gitter 中提问。

その他のルール

textlint 规则集合 · textlint/textlint Wiki

运行测试

npm test

贡献

Pull requests 和 stars 始终欢迎。

对于错误和功能请求，请创建一个 issue。

Fork it
Create your feature branch: git checkout -b my-new-feature
Commit your changes: git commit -am 'Add some feature'
Push to the branch: git push origin my-new-feature
Submit a pull request :D

textlint-rule-preset-ja-technical-writing

Online Demo

安装

用法

ルールの設定方法

ルール一覧

1文の長さは100文字以下とする

カンマは1文中に3つまで

読点は1文中に3つまで

連続できる最大の漢字長は6文字まで

漢数字と算用数字を使い分けます

「ですます調」、「である調」を統一します

文末の句点記号として「。」を使います

二重否定は使用しない

ら抜き言葉を使用しない

逆接の接続助詞「が」を連続して使用しない

同じ接続詞を連続して使用しない

同じ助詞を連続して使用しない

不使用 UTF8-MAC 浊点

不必要な制御文字を使用しない

不必要なゼロ幅スペースを使用しない

感嘆符!！、疑問符?？を使用しない

半角カナを使用しない

弱い日本語表現の利用を使用しない

同一の単語を間違えて連続しているのをチェックする

よくある日本語の誤用をチェックする

冗長な表現をチェックする

入力ミスで発生する不自然なアルファベットをチェックする

対になっていない括弧をチェックする

变更日志

语义化版本策略

Release Flow

ルールの利用者

Community

その他のルール

运行测试

贡献

作者

许可证