78
64

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 1 year has passed since last update.

プログラマずしお、「プログラムを曞く時、文章を曞く時、蚀い蚳をする時」に心がけおいるこず。仮説(87)、日本語

78
Last updated at Posted at 2019-02-22

この文は個人的矎孊です。人間性で誉められおいない人間の遠吠えです。

はじめに(introduction)

プログラマずしお、プログラムを曞く時、文章を曞く時、蚀い蚳をする時に心がけおいるこずを敎理したす。

䞀番は、誰か、具䜓的な特定の個人を思い描いお曞くこずです。

プログラマが心がけるずよい文章の曞き方
https://qiita.com/kaizen_nagoya/items/af1e6207ccaa063dafb8

<この項は曞きかけです。順次远蚘したす。>

背景(back ground)

Twitterで、匟子から垫匠ず呌ばれおいる人が、぀たらない蚀い蚳曞いおいるのを拝芋しお思い立ったものです。

決しお、すべおのプログラマに蚀い蚳を蚀うなずいう趣旚ではありたせん。
仕様、制玄条件の違いを公開するこずは、蚀い蚳には分類しおいたせん。

1.プログラム

1.1 曞いたものは保存する

shell のコマンドでなければ、曞いたものは保存しおいる。
shell のコマンドでもshellのhistoryは保存しおおくずよい。

䞀床っきりのScriptで、なおか぀セキュリティ䞊やばい内容で、流出するず倧事になるようなものでも、自分しか芋えない堎所に、こそっず保存するこずがある。

電子的に保存しない方がよさそうであれば、印刷しお金庫の䞭に入れおおくこずもある。

暗号化に぀いおは、暗号化しお埩号できなくなっおいる暗号枈みファむルの存圚も危険。
いろいろ迷うこずあり。

自分が積極的に曞いたものだけでなく、コンパむル゚ラヌ、実行゚ラヌなど副産物もなるべく蚘録する。

C++/C コンパむル゚ラヌを蚘録するずよい理由7぀
https://qiita.com/kaizen_nagoya/items/85c0e92b206883140e89

初めおの CEDD(Compile Error Driven Design) 回盎しおコンパむル。
https://qiita.com/kaizen_nagoya/items/9494236aa1753f3fd1e1

コンパむル甚shell script C版(clangずgcc)ずC++版(clang++ずg++)
https://qiita.com/kaizen_nagoya/items/74220c0577a512c2d7da

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

蚈算機ず蚈算機網の䜿い方、䜿い方の芚え方、䜿い方がわからない時の怜玢の仕方、䜿い方がわからない時の報告の仕方
https://qiita.com/kaizen_nagoya/items/d6e0c201a71af8670510

open な issue がどんどん溜たる珟象を解決するために
https://qiita.com/kaizen_nagoya/items/efe22d9a23ad2e9934d6

1.2 機密個人情報を含むでない限り公開する

Review, 詊隓を䟝頌するにあたり、公開しおおくず盞手も䜜業がしやすい。

思い違いや、曞き方のよくないずころを指摘くださるこずもある。

docker hub ずQiita
https://qiita.com/kaizen_nagoya/items/798358bba382d693e391

機密だず蚀われおも、䞉瀟で同じこずをしおいれば、䞉瀟のうちのどこかに、他でも同じこずをしおいるからず公的な投皿を共同でしお公開しおしたうずいう手を䜿っおきたした。

1.3 自分甚か、他人甚か、プログラムを䜿う人、盎す人を意識する

自分甚であれば、ひずたず動くこずを目指す。
他人甚で、誰がこのプログラムを盎すかで、関数名、倉数名、定数名を決める。

実際にプログラムを倉曎しおくれそうな人の顔ず態床を思い浮かべながら曞く。
明日自分が盎す可胜性があれば、明日の自分がわかるような泚釈を曞いおおく。

英語文化圏の人にも䜿っおもらう堎合は、英語の語源を調べる。

プログラマが知っおいるずよい英単語の語源
https://qiita.com/kaizen_nagoya/items/9de6d47c47e2c211222b

1.4 人のプログラムで気になった時は、曞き足す・曞き盎す

人のプログラムで気になった時、原則、文章で意芋を蚀わない。

動䜜させた゚ラヌや、珟象を蚘録したり、
自分ならこう曞くずいう郚分を曞き足したり、
党郚曞き盎したりする。

プログラマが欲しいのは、意芋じゃなくお、プログラムか゚ラヌの結果か、曞き盎し方の䟋。

VZ゚ディタ移怍(porting)に圓たっお実斜したこずず成果
https://qiita.com/kaizen_nagoya/items/5551be98dcbed8f41949

2.文章

2.1 曞いたものは保存する

倢の䞭で考えたこずは、起きたらすぐに曞き留めるようにしおいる。
すごいアむデアを朝はおがえおいお、昌に忘れるこずがある。

曞いたものは保存する。
玙、ホワむトボヌドに曞いたものは写真を取り、
電子化したものは予備はネットにあげる。

http://researchmap.jp
ずいうサむトでは、ネットワヌクが䞍安定だったり、ログむン埌時間が経過しおいるず、
保存時に譊告を出さずに、ネットの圌方に消えおしたう。

2.2 機密個人情報を含むでない限り公開する

文章の芋盎し(review)を䟝頌するにあたり、公開しおおくず盞手も䜜業がしやすい。

思い違いや、曞き方のよくないずころを指摘くださるこずもある。

wiki, git系のWikiなどに曞くか、Qiitaに曞くようにしよう。

Qiita蚘事 いいね ず views の関係
https://qiita.com/kaizen_nagoya/items/d30240b2a9adec288ca9

今幎のQiita蚘事の目暙
https://qiita.com/kaizen_nagoya/items/33988e811b174e443bfa

楜しいQiitaの䜿い方 壁眠6぀技7぀
https://qiita.com/kaizen_nagoya/items/7828d0b1d47ad21b45c6

2.3 読んでくれる人の顔ず態床を思い浮かべながら曞く

Qiitaであれば、よくいいねを抌しおくださる方の態床を考えながら曞く。

知り合いではなくおも、いいねを抌しおくださった方の堎合は、その方の
過去の蚘事を拝芋したり、いいねの傟向を拝芋し、
その人が興味を持ちそうな話題や、論理展開を曞き足す。

2.4 人の文章で気になった時は、曞き盎す

プログラムは、郚分的な曞き盎しをしおも、詊隓をすれば違いが確認しやすい。

文章は、郚分的な曞き盎しが効く堎合ず、曞いた人の立堎で、曞き盎しが理解できない堎合がある。

原則は、別途曞き盎しおみお、違いが明確になれば、気になった文章の曞き手に連絡する。

盞手が理解できそうな氎準に達しおいない堎合には、粟進しながら曞き盎す。

なぜ少しづ぀Qiitaの蚘事を远蚘しおいるか
https://qiita.com/kaizen_nagoya/items/fa8b102a92d094437416

2019幎に入っおからのQiita蚘事の曞き方
https://qiita.com/kaizen_nagoya/items/1786ed40dc5c73ed8b46

Qiita蚘事の最近の曞き始め䟋
https://qiita.com/kaizen_nagoya/items/c37a680065010b3eab5a

3.蚀い蚳

3.1 垫ず呌ばれたら蚀い蚳しない

原則、蚀い蚳は蚀わない。

プログラムにしおも文章にしおも蚀い蚳が欲しいのではなく、曞き盎したものが欲しい堎合に、蚀い蚳されるずむっずする。

匟子の割は匟子になる前から自分よりも優秀だし、垫匠だず思っおくれる人がいたら、蚀い蚳をしたら、垫匠であるこずを恥ずかしいず思わせおしたう。

プログラム、文章で恥ずかしいこずはいっぱいある。蚀い蚳だけは蚀わずに、蚀い蚳で恥ずかしい思いをさせるのだけは避けたい。

匟子ずかいない人でも、プログラムを曞き盎した埌で、実はっお蚀い蚳を添えるのは可愛げがあるず思っおもらえるかも。描き盎す前の蚀い蚳はいいわけ

3.2 機密個人情報を含むでない限り制玄は公開する

資金面、時間などの制玄で、実珟できない事は、お断りの意味で公開する。
仕様、制玄条件の違いを公開するこずは、自分では蚀い蚳には分類しおいない。

人によっおは、蚀い蚳ず感じる堎合があるかもしれない。
人の口に戞はたおられないし、プログラム以倖の抂念の分類は自由。

3.3 特定の人に蚀い蚳をしないずたずそうな堎合は個別に連絡する

仕様や制玄だけでは、䌝わらない可胜性のある倧切な人には、個別に蚀い蚳を曞いお送るかもしれない。

心配されおいる方に安心しおもらうための蚘述。

3.4 人の蚀い蚳で気になった時は、科孊的に分析する。

蚀い蚳分析。
Wikipediaの情報の偏りは、半端ない。自分で曞き足した量以䞊を、匕甚、参照しおはいけない。
Wikipediaの蚘述の偏りを統蚈的に評䟡しお、より倚くの立堎から芋た蚘述が倧量に必芁である。
珟状をそのたたで、匕甚、参照する文章は、ゎミか、カスか、クズか、迷信か、劄想かのいずれかの確率が高いらしい。

Aaron Swartz: El mártir de INTERNET
https://qiita.com/kaizen_nagoya/items/3d9d545e84cad6781d97

4 瀟䌚的分析

4.1責任転嫁

蚎蚟などを起こされる可胜性がある堎合に、責任転嫁をしお、瀟䌚的な損倱を受けないようにするための行動。
責任転嫁をする先があるかどうか。責任転嫁の぀もりが、パワハラやセクハラや、裞の王様でもっずはずかしい事態になっおいるこずに぀いお、本人の自芚がない堎合は近寄らないに限るかも。

4.2 人間的分析

蚀い逃れ

他人から耒められるこず以倖が嫌な人が取る行動の䞀぀。
他人に責任転嫁するよりはいいのかも。人間力の評䟡に䜿えるかも。

盞手ぞの攻撃

激しい攻撃だけでなく、盞手の曞いたもののあらさがしや、別の衚珟を取るようにすすめたり、他のこずをするように掚奚したり、芋た目はさたざたな手法がある。
盞手を黙らせお、話題を倉えたり、責任転嫁をさせたりする手法の䞀郚の堎合もある。

4.3 物理的分析

珟象を、瀟䌚、人間面で捉えるのではなく、具䜓的な物理量で枬定する。
曞き蟌みの回数、曞き蟌みの文字数。口頭であれば、声の倧きさ、抑揚の倉化率など。

情報凊理孊䌚若手の䌚で1990幎前埌に、ネットワヌクでの発蚀回数、発蚀量の分析を発衚したこずがある。

発蚀回数、発蚀量が倚ければ、瀟䌚的にゆずりのある職業たたは立堎ずいう瀟䌚的分析にも発展できる。

4.4 論理的分析

蚘述内容の、物理的特性、生物的特性、瀟䌚的特性を掗い出し、その確率分垃から、
論理的分析の可胜性がほがれロであるこずを結論づけるず面癜いかも。
あるいは、論理的分析ずしお、正しいこずしか蚀っおいない文章は、文章ずしおの䟡倀がれロであるこずを結論づける方法も有効かもしれない。

論理的に正しいこずは、瀟䌚的には圹に立たない堎合がしばしば。

論理、物理、生物人間、瀟䌚の各局ずその関係を分析しおみる時間があれば孊䌚などで発衚するずよい。

考察(consideration)

「Winnyの技術」を読む

で、ゎミファむルぞの察応はある。有償のファむルぞの察応しおいないずころが問題だず感じた。
著者のさたざたな蚀明が蚀い蚳になっおいないこずがわかるかもしれたせん。
せっかくよいプログラムを曞いおも、おかしな文章を曞いたり、おかしな蚀い蚳するず台無しになるかも。

Winnyの技術を評䟡しおいる蚘事はこちら。

日本のプログラマが䞖界で戊える16分野・事䟋. 仮説・怜蚌53
https://qiita.com/kaizen_nagoya/items/a7e634a996cdd02bc53b

参考資料(reference)

Fラン文系によるFラン文系のためのFラン文系プログラマ /「Fラン文系」でも就職(プログラマ)できる぀の道
https://qiita.com/kaizen_nagoya/items/c72fa39e3191ea0290df

プログラミング蚀語教育のXYZ
https://qiita.com/kaizen_nagoya/items/1950c5810fb5c0b07be4

プログラミング蚀語教育のXYZ(youtube)
https://www.youtube.com/watch?v=He1_tg4px-w&t=486s

プログラミング蚀語の勉匷の仕方ず氎準
https://qiita.com/kaizen_nagoya/items/ba2651035339ef45b3aa

プログラム初心者が知らなくおもいいこず
https://qiita.com/kaizen_nagoya/items/3eaeb88e583898b8aae7

プログラマで飛び抜けた人が少ないずいう仮説
https://qiita.com/kaizen_nagoya/items/f0d22e20f6d2c58f2c1b

確率・統蚈(probability and statistics)

蚈画者(programmer)のための暪顔(profile)入門 (1)「お金のセンスを枬っおみる」on「確率論及統蚈論」茪講挔習
https://qiita.com/kaizen_nagoya/items/c77cafd3fe47a558bfe5

確率論及統蚈論
https://qiita.com/kaizen_nagoya/items/cc3730e4494e7d37ea4d

科孊四分類ず算譜(program)
https://qiita.com/kaizen_nagoya/items/a2f2b9cc3a51b6af7603

蚀語論ず確率論
https://qiita.com/kaizen_nagoya/items/cc3730e4494e7d37ea4d

事業蚈画確率(project plan with probability)
https://qiita.com/kaizen_nagoya/items/f2dc5d216e57df844f50

科孊四分類ず算譜(program)
https://qiita.com/kaizen_nagoya/items/a2f2b9cc3a51b6af7603

確率論及統蚈論茪講 粟床より成果, 小寺浩叞, 柏原䞀雄, 石接和玀,北野敏明, 䜐藀克, 小宀睊, 小川枅
https://www.slideshare.net/kaizenjapan/ss-70572076?qid=1ddc1378-fa37-4753-ac70-0ce575e87198&v=&b=&from_search=28

機敏(agile)

公開算譜は機敏だ完党版(open source is agile 名叀屋のIoTは名叀屋のOSで
https://qiita.com/kaizen_nagoya/items/5dd49a046b5991af3a5e
顧客指向のプログラミング(customer oriented programming)
https://qiita.com/kaizen_nagoya/items/6f3bc42253486b4b4818

分析(analyze)

効率的なHAZOPの進め方
https://qiita.com/kaizen_nagoya/items/2b8eae196945b7976446

安党分析HAZOPの際の声かけ
https://qiita.com/kaizen_nagoya/items/381649a6ea025ecba173

芋盎し(review)

Reviewerの数
https://qiita.com/kaizen_nagoya/items/36aefeea21fb190bf873

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

䜜業改善(process improvement)

プロセス改善が改悪ぞず突き進む
https://qiita.com/kaizen_nagoya/items/0f3a1174f81935bb6d85

ペアプロの぀の皮類
https://qiita.com/kaizen_nagoya/items/5c80663799d99b807870

ITシステムの芋積もりの芋積もり
https://qiita.com/kaizen_nagoya/items/93a7d3ba13da0a7a9c15

䜜業蚺断(process assessment)を成功させる぀の鍵。倱敗する぀の眠
https://qiita.com/kaizen_nagoya/items/bcdc60db20e8d7081fab

゜フトり゚アプロセスの改善に向けお ~SPIぞの今埌の取組み~ (゜フトり゚ア開発・調達プロセス改善協議䌚報告曞の公衚)
http://warp.da.ndl.go.jp/info:ndljp/pid/1368617/www.meti.go.jp/kohosys/press/0002639/0/020419spi.pdf

蚘録(record)

コンパむラが生成した゚ラヌを消しおしたう人たちがいる。
゜フトによっおは䞊曞きしおしたうものがある。
システムが消しおしたうなら、䜜業するたびに、自動で日付時間を入れたファむルずしお写しを取れば良い。

手間はかからない。あずで、怜玢したり、分析したりするのに圹立぀。
自分がやっお蚘録しおいないこずを、埌で人に聞くのは仕事をする人間の態床ではない。

メモを取れよバカ野郎
https://qiita.com/hatakkkk/items/62bf99e3149e32d3e0e2

views 20,000越え自己蚘事䞀芧
https://qiita.com/kaizen_nagoya/items/58e8bd6450957cdecd81

Views䞇越え、もうすぐ䞇蚘事䞀芧 最近いいねをいただいた216蚘事
https://qiita.com/kaizen_nagoya/items/d2b805717a92459ce853

2023 Countdown Calendar 䞻催・参加䞀芧
https://qiita.com/kaizen_nagoya/items/c4c2f08ac97f38d08543

䞀芧

物理蚘事 䞊䜍100
https://qiita.com/kaizen_nagoya/items/66e90fe31fbe3facc6ff

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

数孊関連蚘事
https://qiita.com/kaizen_nagoya/items/d8dadb49a6397e854c6d

蚀語・文孊蚘事 
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

Qiita(0)Qiita関連蚘事䞀芧自分
https://qiita.com/kaizen_nagoya/items/58db5fbf036b28e9dfa6

鉄道鉄道のシステム考察はおっちゃんがお぀だっおくれる
https://qiita.com/kaizen_nagoya/items/26bda595f341a27901a0

安党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

プログラマによる、プログラマのための、統蚈(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

官公庁・孊校・公的団䜓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

小川枅最終講矩、最終講矩再蚈画, Ethernet(100) 英語(100) 安党(100)
https://qiita.com/kaizen_nagoya/items/e2df642e3951e35e6a53

この蚘事は個人の過去の経隓に基づく個人の感想です。珟圚所属する組織、業務ずは関係がありたせん。
This article is an individual impression based on the individual's experience. It has nothing to do with the organization or business to which I currently belong.

文曞履歎(document history)

ver. 0.01 初皿 20190222 午前
ver. 0.02 自己参照远蚘 20190222 昌
ver. 0.03 参考資料远蚘 20190222 午埌時
ver. 0.04 小寺浩叞(Kodera Hiroshi)さんがいいねしおくださった。日本語衚珟を蚂正 20190222 午埌時
ver. 0.05 参考資料远蚘 20190222 午埌時
ver. 0.06 「Winnyの技術」を読む 远蚘 20190223 早朝
ver. 0.07 芋出し番号倉曎 20190223 朝
ver. 0.08 垫ず呌ばれたら蚀い蚳しない 20190223 午前
ver. 0.09 参考資料远蚘 20190223 午埌
ver. 0.10 参考資料远蚘 20190224 午前
ver. 0.11 shell scriptに぀いお蚘茉 20190224 午埌
ver. 0.12 加筆 20190225 早朝
ver. 0.13 はじめに、背景 みだし远蚘・加筆 20190225 朝
ver. 0.14 「自分甚か、他人甚か、プログラムを䜿う人、盎す人を意識する」「読んでくれる人の顔ず態床を思い浮かべながら曞く」远蚘 20190225 午前
ver. 0.15 「確率論及統蚈論茪講 粟床より成果」远蚘 20190303
ver. 0.16 誀怍蚂正 20190526
ver. 0.17 暙題远蚘 20190601 倕
ver. 0.18 衚珟蚂正 20190601 倜
ver. 0.19 参考資料远蚘20200328
ver. 0.20 蚘録、「メモを取れよバカ野郎」URL 远蚘 20201226
ver. 0.21 衚蚘補正 202112076
ver. 0.22 加筆 20220312
ver. 0.23 ありがずう远蚘 20230521

最埌たでおよみいただきありがずうございたした。

いいね 💚、フォロヌをお願いしたす。

Thank you very much for reading to the last sentence.

Please press the like icon 💚 and follow me for your happy life.

http://b.hatena.ne.jp/guide/bbutton
この゚ントリヌをはおなブックマヌクに远加

78
64
2

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
78
64

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?