レビューの工夫 品質(22)

ソースコードレビューなど、設計審査(design review)は製造業、IT業界でも重要です。

# Reviewerの能力
製造業とIT業界で大きな違いを感じるのは、Reviewerの能力の管理形態です。

製造業では、どの製品、どの技術を検討する場合には、誰と、誰と、誰の入った設計審査が必要だとすることがある。

IT業界でも、言語、OS、アプリの種類などで、その技術について、社内で最高の人を割りあてていることもある。

設計審査担当が超絶な人がいない場合には、納期、品質、費用の３人に分けて、それぞれの視点だけの意見をだすようにする方法もある。

IT業界でも、この人が見てなきゃ、出荷しちゃだめって、能力のある人を関門にしている場合があります。

その際に、なぜ、その人が見なきゃだめかの根拠を明示的に示していないことがあるような気がします。

オープンソース事業では、コードを書いた人の名前が残っており、こういうコードを書く人にはみてもらわなきゃってなって、根拠がわかりやすい。

ソースコードに人名を書かない事業だと、なんであの人がReviewerするのかってならないでしょうか。ちゃんとソースコードには人名を書くようにしましょう。

データを作った人、試験をした人、Reviewをした人も名前を刻みましょう。

# 静的検査・統計、整形
ソースコードレビューの前にしておくとよいこと。仮説（35）
https://qiita.com/kaizen_nagoya/items/bcd97b3358f0ee244fe5

レビューする前に、特定の道具で整形し、静的検査します。
ついでに、統計も取れば、作業の無駄が省けることがあります。

一番のおすすめは、単語の頻度表です。
一度しか現れない単語のうち、定義だけして使っていない変数、定数は、静的検査の道具（checker)で検査できます。それ以外に一度しか現れない単語が、注釈(comment)の用語であれば問題ないでしょう。その言語の予約語でも問題ないでしょう。

１文字だけ違う変数、定数は、checkerで検査できる場合があります。
２文字間違えるとチェッカで検査できないかもしれません。
checkerで対応できないところを、単語出現頻度表で確認するかもしれません。

# レビュー方法
レビューにはいくつかの手法や、進め方があります。

IEC 61160:2005 Design review
https://webstore.iec.ch/publication/4707

IEC 61025:2006  Fault tree analysis (FTA)
https://webstore.iec.ch/publication/4311

EC 62502:2010 Analysis techniques for dependability - Event tree analysis (ETA)
https://webstore.iec.ch/publication/7131

IEC 60812:2018  Failure modes and effects analysis (FMEA and FMECA)
https://webstore.iec.ch/publication/23262

IEC 62740:2015 Root cause analysis (RCA)
https://webstore.iec.ch/publication/21810

IEC 61882:2016 RLV  Hazard and operability studies (HAZOP studies) - Application guide
https://webstore.iec.ch/publication/24314

IEC 60300-3-1:2003  
Dependability management - Part 3-1: Application guide - Analysis techniques for dependability - Guide on methodology
https://webstore.iec.ch/publication/1294
ディペンダビリティ管理－第３－１部：適用の指針－ディペンダビリティ解析手法の指針
https://kikakurui.com/c5/C5750-3-1-2006-01.html


JISK0050	化学分析方法通則
https://www.kikakurui.com/k0/K0050-2019-01.html

JISK0126	流れ分析通則
http://kikakurui.com/k0/K0126-2019-01.html

JISK0129	熱分析通則
https://kikakurui.com/k0/K0129-2005-01.html

これらをすべて知っていないと、ソースコードレビューができないという訳ではありません。
これらの知見があれば、システムが発熱したり、発火したりして結果として動かなくなるということを防ぐことができるという感じかなって思います。

IECの分析手法は、過去トラ(trouble data base)などを整理して体系的に利用するための手法であるとともに、これまで起こらなかった事象を効率的に予測するための手法です。どれか一つ知っていてもいいです。なぜなぜ分析といっているのは、これらの手法をできればすべてうまく使ってやると効率的だという経験則があります。一つの手法だけに偏った分析をしていると、予測事象空間も偏る可能性があります。

# Reviewの勧め方
## github, Markdownの利用（記録）
Githubをはじめとして、例えば文書はMarkdownで記載してWiki形式で整理します。
代替方法として表で管理することも可能ですが、10000件くらいを超えた時点で表よりはMarkdownで分類した一覧でかつ、全文検索できるのがよいでしょう。

## 対面とネットの均衡（検討）
Reviewというと、集まって、わいわいがやがややって意思一致すること（わいがや）だという仕事の仕方をされている組織があるとお聞きしたことがあります。

製造業の工程のように、どこかが少しでも止まると全体に影響を与えるような仕事の仕方をしている場合は「わいがや」も有効かもしれません。

ソースコードのように、よい設計であれば、部分ごとに試験をして、並列で作っていくことができる場合には、わいがやは必ずしも有効ではないというのが経験則です。

ネットでコンパイラやエディタ、OSなどがオープンソースでできてきた時に、９割くらいの時間がネットだけで対面での会議は、少数のコアチームだけで実施していたような気がします。

組織によって対面の割合が１割から５割くらいまではいろいろあると思いますが、５割を超えた時点で無駄だと思うとよいというのが経験則です。

## 指摘・改善案
指摘だけをした方がいいという流派があることは存じ上げています。
今時、静的検査の道具(checker)でも、改善候補を挙げる機能がついていることがあるかもしれない。

その際、指摘だけするか、解決策の案を１つから３つ提示するかなどのやり方がある。

指摘だけするのは、審査担当の時間が超過密な場合である。
解決策の候補は、他の担当でも出せるような場合にそうすることがある。

解決策の例を１つだけ示すのはお勧めできない。
それに依存したり、制約だと思ってなぞる場合が横行する可能性があるからである。

２つ示す場合は、えいやで選ぶことがある。３つ示す場合は、採用の根拠を示すとよい。

## 課題(issue)
ネットでやっていると、課題(issue)の上げすぎ、重複、矛盾を取るのが一つの課題になります。

LinuxのkernelソースのMailing Listなどでは、Alan Coxが仕切ってくれていて、日本のmailing listでは相手にしてもらえないような意見も、きちんとひろって課題として認識してもらえたことがあります。

課題を上げだすと切りがない面があり、どのような制約条件下のものだけ対応することにしても、大きいものと小さいものが混在したりします。

仮説・(96) open な issue がどんどん溜まる現象を解決するために
https://qiita.com/kaizen_nagoya/items/efe22d9a23ad2e9934d6

## 質問票(questionnaire)
人の話にいちいち無駄な質問か、誤字の指摘か文句をつけて無駄な時間を費やす。
その場で何も言わずに、陰口をついたり上につまらないことをチクる。
解決策を一つに限定し、押し付ける。

指摘だけして解決策を聞いても言わない。

# 参考資料(reference)

私達のレビュー技法（リーディング技法）

https://qiita.com/kazuo_reve/items/cd1db594edaf0d296617#_reference-c6298d48ab8197fc555d

## 自己参照
プログラマが英語で報告・質問する時のいくつかの事例・方法
https://qiita.com/kaizen_nagoya/items/9cf2ba858e52e9795b67

プログラマの「日報、週報、月報、年報」考
https://qiita.com/kaizen_nagoya/items/97ad8ac9217c12c3bb69

bitbucket/github/gitlab連携環境構築（中）悪戦苦闘
https://qiita.com/kaizen_nagoya/items/87352fe88ceed2c1732d

IT系勉強会をすべて当たりにする方法
https://qiita.com/kaizen_nagoya/items/9f001a79ab4162220406

<この項は書きかけです。順次追記します。>
This article is not completed. I will add some words in order.

## Engineering Festa 2024前に必読記事一覧
programの本質は計画だ。programは設計だ。
https://qiita.com/kaizen_nagoya/items/c8545a769c246a458c27

登壇直後版 色使い(JIS安全色) Qiita Engineer Festa 2023〜私しか得しないニッチな技術でLT〜 スライド編 0.15
https://qiita.com/kaizen_nagoya/items/f0d3070d839f4f735b2b

プログラマが知っていると良い「公序良俗」
https://qiita.com/kaizen_nagoya/items/9fe7c0dfac2fbd77a945

逆も真：社会人が最初に確かめるとよいこと。OSEK(69)、Ethernet(59)
https://qiita.com/kaizen_nagoya/items/39afe4a728a31b903ddc

統計の嘘。仮説（127）
https://qiita.com/kaizen_nagoya/items/63b48ecf258a3471c51b

自分の言葉だけで論理展開できるのが天才なら、文章の引用だけで論理展開できるのが秀才だ。仮説（136）
https://qiita.com/kaizen_nagoya/items/97cf07b9e24f860624dd

参考文献駆動執筆(references driven writing)・デンソークリエイト編
https://qiita.com/kaizen_nagoya/items/b27b3f58b8bf265a5cd1

「何を」よりも「誰を」。１０年後のために今見習いたい人たち
https://qiita.com/kaizen_nagoya/items/8045978b16eb49d572b2

Qiitaの記事に３段階または５段階で到達するための方法
https://qiita.com/kaizen_nagoya/items/6e9298296852325adc5e

出力(output)と呼ばないで。これは状態(state)です。
https://qiita.com/kaizen_nagoya/items/80b8b5913b2748867840

coding (101) 一覧を作成し始めた。omake:最近のQiitaで表示しない5つの事象
https://qiita.com/kaizen_nagoya/items/20667f09f19598aedb68

あなたは「勘違いまとめ」から、勘違いだと言っていることが勘違いだといくつ見つけられますか。人間の間違い(human error(125))の種類と対策
https://qiita.com/kaizen_nagoya/items/ae391b77fffb098b8fb4

プログラマの「プログラムが書ける」思い込みは強みだ。３つの理由。仮説（168）統計と確率(17) , OSEK(79)
https://qiita.com/kaizen_nagoya/items/bc5dd86e414de402ec29

出力(output)と呼ばないで。これは状態(state)です。
https://qiita.com/kaizen_nagoya/items/80b8b5913b2748867840

これからの情報伝達手段の在り方について考えてみよう。炎上と便乗。
https://qiita.com/kaizen_nagoya/items/71a09077ac195214f0db

ISO/IEC JTC1 SC7 Software and System Engineering
https://qiita.com/kaizen_nagoya/items/48b43f0f6976a078d907

アクセシビリティの知見を発信しよう！（再び）
https://qiita.com/kaizen_nagoya/items/03457eb9ee74105ee618

統計論及確率論輪講（再び）
https://qiita.com/kaizen_nagoya/items/590874ccfca988e85ea3

読者の心をグッと惹き寄せる7つの魔法
https://qiita.com/kaizen_nagoya/items/b1b5e89bd5c0a211d862

「@kazuo_reve 新人の方によく展開している有益な情報」確認一覧
https://qiita.com/kaizen_nagoya/items/b9380888d1e5a042646b

ソースコードで議論しよう。日本語で議論するの止めましょう（あるプログラミング技術の議論報告）
https://qiita.com/kaizen_nagoya/items/8b9811c80f3338c6c0b0

脳内コンパイラの3つの危険
https://qiita.com/kaizen_nagoya/items/7025cf2d7bd9f276e382

心理学の本を読むよりはコンパイラ書いた方がよくね。仮説（34）
https://qiita.com/kaizen_nagoya/items/fa715732cc148e48880e

NASAを超えるつもりがあれば読んでください。
https://qiita.com/kaizen_nagoya/items/e81669f9cb53109157f6

データサイエンティストの気づき!「勉強して仕事に役立てない人。大嫌い!!」『それ自分かも?』ってなった!!! 
https://qiita.com/kaizen_nagoya/items/d85830d58d8dd7f71d07

「ぼくの好きな先生」「人がやらないことをやれ」プログラマになるまで。仮説（37）　
https://qiita.com/kaizen_nagoya/items/53e4bded9fe5f724b3c4

なぜ経済学徒を辞め、計算機屋になったか（経済学部入学前・入学後・卒業後対応） 転職(1)  
https://qiita.com/kaizen_nagoya/items/06335a1d24c099733f64    

プログラミング言語教育のXYZ。 仮説（52） 
https://qiita.com/kaizen_nagoya/items/1950c5810fb5c0b07be4

【24卒向け】9ヶ月後に年収１０００万円を目指す。二つの関門と三つの道。
https://qiita.com/kaizen_nagoya/items/fb5bff147193f726ad25

「【25卒向け】Qiita Career Meetup for STUDENT」予習の勧め
https://qiita.com/kaizen_nagoya/items/00eadb8a6e738cb6336f

大学入試不合格でも筆記試験のない大学に入って卒業できる。卒業しなくても博士になれる。
https://qiita.com/kaizen_nagoya/items/74adec99f396d64b5fd5

全世界の不登校の子供たち「博士論文」を書こう。世界子供博士論文遠隔実践中心 安全(99)
https://qiita.com/kaizen_nagoya/items/912d69032c012bcc84f2

小川メソッド　覚え（書きかけ）
https://qiita.com/kaizen_nagoya/items/3593d72eca551742df68

DoCAP（ドゥーキャップ）って何ですか？
https://qiita.com/kaizen_nagoya/items/47e0e6509ab792c43327

views 20,000越え自己記事一覧
https://qiita.com/kaizen_nagoya/items/58e8bd6450957cdecd81

Views１万越え、もうすぐ１万記事一覧 最近いいねをいただいた213記事
https://qiita.com/kaizen_nagoya/items/d2b805717a92459ce853

# 関連資料
' @kazuo_reve 私が効果を確認した「小川メソッド」
https://qiita.com/kazuo_reve/items/a3ea1d9171deeccc04da

' @kazuo_reve 新人の方によく展開している有益な情報
https://qiita.com/kazuo_reve/items/d1a3f0ee48e24bba38f1

' @kazuo_reve Vモデルについて勘違いしていたと思ったこと
https://qiita.com/kazuo_reve/items/46fddb094563bd9b2e1e

# 自己記事一覧
Qiitaで逆リンクを表示しなくなったような気がする。時々、スマフォで表示するとあらわっることがあり、完全に削除したのではなさそう。

４月以降、せっせとリンクリストを作り、統計を取って確率を説明しようとしている。
2025年２月末を目標にしている。

物理記事　上位100
https://qiita.com/kaizen_nagoya/items/66e90fe31fbe3facc6ff

量子(0) 計算機, 量子力学 
https://qiita.com/kaizen_nagoya/items/1cd954cb0eed92879fd4

数学関連記事１００
https://qiita.com/kaizen_nagoya/items/d8dadb49a6397e854c6d

統計(0)一覧
https://qiita.com/kaizen_nagoya/items/80d3b221807e53e88aba

図(0) state, sequence and timing. UML and お絵描き 
https://qiita.com/kaizen_nagoya/items/60440a882146aeee9e8f

品質一覧 
https://qiita.com/kaizen_nagoya/items/2b99b8e9db6d94b2e971

言語・文学記事　１００
https://qiita.com/kaizen_nagoya/items/42d58d5ef7fb53c407d6

医工連携関連記事一覧
https://qiita.com/kaizen_nagoya/items/6ab51c12ba51bc260a82

自動車　記事　１００
https://qiita.com/kaizen_nagoya/items/f7f0b9ab36569ad409c5

通信記事１００
https://qiita.com/kaizen_nagoya/items/1d67de5e1cd207b05ef7

日本語（０）一欄
https://qiita.com/kaizen_nagoya/items/7498dcfa3a9ba7fd1e68

英語(0) 一覧
https://qiita.com/kaizen_nagoya/items/680e3f5cbf9430486c7d

転職(0)一覧
https://qiita.com/kaizen_nagoya/items/f77520d378d33451d6fe

仮説（0）一覧（目標100現在40）
https://qiita.com/kaizen_nagoya/items/f000506fe1837b3590df

音楽　一覧(0) 
https://qiita.com/kaizen_nagoya/items/b6e5f42bbfe3bbe40f5d

「@kazuo_reve 新人の方によく展開している有益な情報」確認一覧 
https://qiita.com/kaizen_nagoya/items/b9380888d1e5a042646b

Qiita(0)Qiita関連記事一覧（自分）
https://qiita.com/kaizen_nagoya/items/58db5fbf036b28e9dfa6

鉄道（０）鉄道のシステム考察はてっちゃんがてつだってくれる
https://qiita.com/kaizen_nagoya/items/faa4ea03d91d901a618a

安全（0）安全工学シンポジウムに向けて: 21
https://qiita.com/kaizen_nagoya/items/c5d78f3def8195cb2409

一覧の一覧( The directory of directories of mine.) Qiita(100)
https://qiita.com/kaizen_nagoya/items/7eb0e006543886138f39

Ethernet 記事一覧　Ethernet(0)
https://qiita.com/kaizen_nagoya/items/88d35e99f74aefc98794

Wireshark 一覧 wireshark(0)、Ethernet(48) 
https://qiita.com/kaizen_nagoya/items/fbed841f61875c4731d0

線網（Wi-Fi）空中線(antenna)(0) 記事一覧(118/300目標)
https://qiita.com/kaizen_nagoya/items/5e5464ac2b24bd4cd001

OSEK OS設計の基礎　OSEK(100)
https://qiita.com/kaizen_nagoya/items/7528a22a14242d2d58a3

Error一覧 error(0)
https://qiita.com/kaizen_nagoya/items/48b6cbc8d68eae2c42b8

C++ Support(0)　
https://qiita.com/kaizen_nagoya/items/8720d26f762369a80514

Coding(0) Rules, C, Secure, MISRA and so on
https://qiita.com/kaizen_nagoya/items/400725644a8a0e90fbb0

coding (101) 一覧を作成し始めた。omake:最近のQiitaで表示しない5つの事象
https://qiita.com/kaizen_nagoya/items/20667f09f19598aedb68

プログラマによる、プログラマのための、統計(0)と確率のプログラミングとその後
https://qiita.com/kaizen_nagoya/items/6e9897eb641268766909

なぜdockerで機械学習するか 書籍・ソース一覧作成中 (目標100)
https://qiita.com/kaizen_nagoya/items/ddd12477544bf5ba85e2

言語処理100本ノックをdockerで。python覚えるのに最適。:10+12
https://qiita.com/kaizen_nagoya/items/7e7eb7c543e0c18438c4

プログラムちょい替え（0）一覧:4件
https://qiita.com/kaizen_nagoya/items/296d87ef4bfd516bc394

Python(0)記事をまとめたい。
https://qiita.com/kaizen_nagoya/items/088c57d70ab6904ebb53

官公庁・学校・公的団体（NPOを含む）システムの課題、官（０）
https://qiita.com/kaizen_nagoya/items/04ee6eaf7ec13d3af4c3

「はじめての」シリーズ　 ベクタージャパン　
https://qiita.com/kaizen_nagoya/items/2e41634f6e21a3cf74eb

AUTOSAR(0)Qiita記事一覧, OSEK(75)
https://qiita.com/kaizen_nagoya/items/89c07961b59a8754c869

プログラマが知っていると良い「公序良俗」
https://qiita.com/kaizen_nagoya/items/9fe7c0dfac2fbd77a945

LaTeX(0) 一覧　
https://qiita.com/kaizen_nagoya/items/e3f7dafacab58c499792

自動制御、制御工学一覧（０）
https://qiita.com/kaizen_nagoya/items/7767a4e19a6ae1479e6b

Rust(0) 一覧　
https://qiita.com/kaizen_nagoya/items/5e8bb080ba6ca0281927

100以上いいねをいただいた記事16選
https://qiita.com/kaizen_nagoya/items/f8d958d9084ffbd15d2a

小川清最終講義、最終講義（再）計画, Ethernet(100) 英語(100) 安全(100)
https://qiita.com/kaizen_nagoya/items/e2df642e3951e35e6a53

＜この記事は個人の過去の経験に基づく個人の感想です。現在所属する組織、業務とは関係がありません。＞
This article is an individual impression based on my individual experience. It has nothing to do with the organization or business to which I currently belong.
### 文書履歴(document history)
ver. 0.01 初稿　20201212
ver. 0.02 @kazuo_reve 私達のレビュー技法（リーディング技法）　参照にともない、整形・静的検査・単語頻度表　加筆 20220531
### 最後までおよみいただきありがとうございました。
いいね　💚、フォローをお願いします。
#### Thank you very much for reading to the last sentence.
Please press the like icon 💚　and follow me for your happy life.