0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

意味のあるドキュメントレビューをするために

Posted at

”雰囲気レビュー”(なんちゃってレビュー)にならないように、意味のあるレビューができるとよいと思っています。

レビュー作業について,まとめてみました.


構成、校正、校閲について

レビューと呼ばれる作業には、以下の3つがあると思います。

構成:文章の目的に合わせて、章立てや話の流れを整理する
校正:元原稿とくらべて、明かな字句の間違いを直す
校閲:校正に加え、元原稿に書いてある内容の事実関係にまで踏み込んでチェック

  • 誤字、内容の矛盾などの間違いを見つける
  • 書かれていること(地名や固有名詞、サービス内容、データ類など)が正しいのか調べて確認する

参考


それぞれで、チェックする項目が違います。

構成作業をするとしたら、

  • 章構成は分かりやすいか
  • 章の前後関係はどうか
  • 重複していたり、足りない項目はないか
    のようなチェックをすることになると思います。

校正作業をするとしたら、

  • 誤字脱字はないか
  • 用語の揺れチェック
    のようなチェックをすることになると思います。

校閲作業をするとしたら、

  • 目標設定や、課題設定に対して、活動内容が対応しているか?結論がどうなっているか?
  • スケジュールで書かれている作業とその後の章で書かれている作業は対応がとれているか
  • スケジュールで書かれている作業は本当にその時期にその作業をしたのか?
  • 類似サービスで取り上げているサービスは本当に書いてあるとおりのサービスなのか?
  • 役割設定で書かれている作業をグループの章や個人作業の章で書かれているか?
  • グループ作業で書かれている作業を個人作業で書かれているか?逆に、個人作業で書いてあるがグループ作業で書いていない作業はないか?
  • グループ作業で書かれている問題点と個人作業で書かれている問題点が対応しているか?
    のようなチェックをすることになると思います。

校正、校閲作業のアイディア

校正、校閲作業のアイディアをいくつか考えてみました。

フィードバックをする

  • レビューしてもらったコメントに反応する
  • コメントを受けてどう変更したのかをレビュアに分かるようにする
  • 分からない点などを放置しづらい環境を作る
  • フィードバックの間隔を短くする

可視化する

  • 各章、節でなにを書くべきか、なにを書いてあるかを可視化する
  • レビュー作業の進捗を可視化する
    − レビューコメントと修正結果を可視化する

作業単位を小さくする

  • 1回に書いてもらう量、チェックしてもらう量を少なくする
  • 執筆期間、チェック期間を短くして、その間に終わる作業をしてもらう
  • グループを小さくして、その中でチェックしてもらう

矛盾が少ない文章を使う

  • サービス企画書やアプリケーション設計書、議事録など、すでにチェック済みの文章をうまく流用する

チェックの自動化、半自動化を考える

  • RedPen, textlint、wordの機能などを使い、自動化できるチェックを自動化する
  • 文脈依存で使い方が変わるなど、自動チェックしづらい書き方などは極力しないようにする
  • git+Weckerなど使い、作業者が作業しなくてもよい環境を作る
  • ChatGPT等を利用する

客観的に読み直す

  • 一度書いた原稿を、時間をおいて読み直す
  • スケジュールに読み直す時間を割り当てる必要あり
  • 他のメンバにチェックしてもらう
  • チェックもルーチン化しておく
  • チェックしてもらえたかどうか確認(テスト?)するなど

作業の繰り返しを防ぐ

  • 一度指摘したり、修正した箇所を再度チェックしなくてもよい環境を作る
  • 同じマスターファイルを使うとか、差分を自動でチェックできるような仕掛けを作るとか

校閲しやすい文章を書く

  • 出典があるなら明記する
  • 参照関係を明記する
  • 文脈依存で使い方が変わるなど、自動チェックしづらい書き方などは極力しないようにする

参考


0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?