Qiitaのリリースノートをtextlintでチェックするようにした - Qiita
この記事は、Qiita株式会社のカレンダー | Advent Calendar 2023 - Qiitaの1日目の記事です。 Qiitaには、どんな機能やバグ修正がリリースされたかを確認できるリリースノートがあります。 リリースノートの更新は、機能やバグ修正をリリースする人が一緒に対応をする運用になっているのですが、開発するメンバーが増えてきたことにより、様々な記述スタイルで書かれている状態となっていました。 そこで、textlintを導入して記述スタイルを揃えるようにしたので紹介します。 textlintとは 日本語などの文章校正をするためのlinterです。 様々なRuleが用意されており、「ですます調」「である調」を統一するものや二重否定を使わないようにするものなどがあります。 また、Pluginを使うことでテキストファイルやMarkdownファイル以外のファイルもlintできるよう
ブログ校正の作法：textlintで強化するテクニカルライティング - Qiita
HRBrain Advent Calendar 2023 1日目の記事です。 はじめに こんにちは。@yug1224(Yuji Yamaguchi)です。 今年もAdvent Calendarが始まりましたね！そろそろ記事を書かなきゃと焦っている人も多いのではないでしょうかｗ 本記事では、私が文章作成時に気を付けているテクニカルライティングの観点と、そのために使っているtextlintのルールを紹介します。 テクニカルライティングとは テクニカルライティングとは、技術的な内容を正確かつ効率的に伝えるために誕生した文章作成技術です。 コンピューターやICT技術の発達により、今ではあらゆる職種の人に文章を書く機会があるため、テクニカルライティングの技術はビジネスパーソンにとって必須の技術となっています。 オススメ書籍 テクニカルライティングに関する書籍や記事はたくさんありますが、私は以下の書籍
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
