About style guide

[erechorse]

現在は暫定で #3 にて定義されたlintを設定していますが、もう少し内容を詰めていけたらと思います。

なお、現状は基本的には https://github.com/textlint-ja/textlint-rule-preset-ja-technical-writing に従いつつ

• カンマは1文中に3つまで
• 感嘆符!！、疑問符?？を使用しない
• 1文の長さは100文字以下とする

の3つがfalseになっています。

検討中のスタイルガイドの変更点

• 英語の単語の両端にスペースを加えない
  • Update textlint rule #25
• 文末の句点として「:」 (コロン) を許容
  • About style guide #6 (comment)
  • Update textlint rule #25
• ですます口調に統一
  • About style guide #6 (comment)
  • Update textlint rule #25
• kindの表記方法の統一
  • About style guide #6 (comment)
• 冗長表現の例外設定
  • NIP-05翻訳のtextlintルール #29
  • Change lint rule #33
• 弱い表現の許容
  • NIP-05翻訳のtextlintルール #29
  • Change lint rule #33
• だ・である口調に統一
  • About style guide #6 (comment)

他にもありましたら提案してください。

[jiftechnify]

「"MUST", "SHOULD", "MAY"のような、RFC2119の規約を借用して要求レベルを指定する語については、その訳の後に括弧書きで元の単語を付記する」という規約があると良さそうです。

これをtextlintで自動チェックするのはおそらく無理なので、レビューで確認してもらうしかありませんが…

[erechorse]

@darashi さんより、NIPsに頻出する、表記ゆれしがちな言葉の対訳リストを作ったほうがよいという提案をいただきました。

e.g.

• Parameterized Replaceable Events
  • パラメータつき置換可能イベント
  • パラメータつき上書き可能イベント

textlintの設定である程度は対応可能かと思います。

[erechorse]

NIP-02の翻訳中、For exampleを例:と訳すと現状のlintの設定だとエラーが出るので、文末の句点ルールはなくてもよいという話が出ています。句点のチェックが手動になってしまうのはデメリットかもしれません。

[erechorse]

関連: #6 (comment) 、 #19

毎度のことなので、MUST、SHOULD、MAYの訳語は固定してしまったほうが良いかもしれません。個人的には

• MUST: 「～しなければなりません」
• SHOULD: 「～するべきです」
• MAY: 「してもかまいません」

のように意識しています。

[darashi]

私が訳した部分でいま↑に準拠していない例として、 NIP-01 の 以下があります。

The 4th parameter MUST always be present, but MAY be an empty string when the 3rd is true, otherwise it MUST be a string formed by a machine-readable single-word prefix followed by a : and then a human-readable message.

を

4番目のパラメータも必須で（MUST）、3番目がtrueである場合は空文字列でもかまいません（MAY）が、そうでなければ、機械可読な一語のプレフィクスに続けて:と人間可読なメッセージを含まなければなりません（MUST）。

と訳しました（そもそもこの文が難しい気がする）。

「4番目のパラメータも存在しなければならず（MUST）、」という感じになるでしょうか。訳の自由度は下がりますが基準があるメリットのほうが大きいかもしれないですね。

[darashi]

https://github.com/textlint-ja/textlint-rule-no-mix-dearu-desumasu はデフォルトだと統一されているか、をチェックするようなので、どちらかに揃っていると pass しそうです。まだ中をちゃんと見られていないのですが、以下のように「ですます」を設定した場合でも、助動詞「だ」「である」が一切使われていないと pass するような動作をしていそうです。おしい。

https://github.com/darashi/nips-ja/blob/desumasu-check/.textlintrc.json

[erechorse]

@SnowCait さんより、原文側にkind-x、kind `x`、kind xなどの表記揺れがあるのでとりあえず翻訳側でもどれかに統一した方が良いのでは、という意見をいただきました。

[erechorse]

#29

[s3-odara]

ですます調のルールで文末以外も厳しくチェックするルールが有効になっていますが、

#24 (comment)

長文投稿は編集可能であることを意図しているため

のような文中の「であること」が検知されるのは想定通りの動作でしょうか。
修正するなら「編集可能なこと」ですかね。

[erechorse]

個人的にも、文中の「であること」がよく検知されるので気になりつつ放置していた点でした。

ただ、そもそも 「だ・である」調に翻訳を切り替えた方が良いのではないか という意見があるので、差し当たって今はlint ruleを通るように文中の表現を微調整して対処しています。