「仕事のコード」を残す際のチェックリスト｜Uchio Kondo

最初に注意: この文章は「はじめに」「総論」が長いです🙃 追記＠2021/08/11 17:46想像よりはるかに反響をいただいたので、せっかくだからと要点をMarkdownにしてGitHubに置いてみました。何かにご利用ください。 はじめに・「仕事のコード」、つまり、業務などで作ったコードが、なるべく負債にならず、なるべく俗人化しないようにするために留意すると良さそうなことを自分の経験などから列挙したものです。 ・ちなみに、「対象読者」に書いてありますが、そもそものモチベーションが「非エンジニアがノーコード系のサービスで作ったシステムが最近増えつつあるような...」というところでした。こういうのどう取り扱うといいんですかねとなった時、まずは運用できる形にしてもらいたい、という狙いがあります。結果的に、ジュニアなエンジニアが良いシステムを残す上でも使える知識かなと思います。 ・個別の項目に

[shirontan]

コメントアウトで動き方の注釈だけつけた私作の「はじめてのVBA」が今日も職場でぐるぐる回っています。私が辞めたらあの2000行が火を吹くやでー。とも言ってられないので暇な時期になったら資料整備します。

[vuy]

Whyに含まれてるのかもしれないけど「BFCを作ってください」と明記したいかな。この業務はそもそも誰が何をしてどんなアウトプットが必要なんですか。が分からないとつらい。

[clockwork9]

周囲から見て後任者の動きが悪いと感じる時は、これを満たしていないことが多い。前任者の尻拭いにかかる工数は本人以外から把握が難しい上、前任者と後任者のスキル差に比例して工数が増えるのも厄介な要素。

[kzm1760]

書き捨てだと思っているツールを作る場合でも大事な視点だ。ドキュメントには半年後の自分でも分かるように、その時点で暗黙知だと思われることを書くようにしている（他の人が知り得ない知るのに苦労する情報）。

[sabinezu]

運用の意識が低いと自覚してる奴なんかいる？自覚できないから意識が低いんでしょ。知識・スキルならわかる。ていうかここまで考えてやる人間は日本中にほとんどいないと思うわ。技術者目線の理想論。

[chOn]

VBAはvbacっていうソースコードのインポートエクスポートを駆使してテキストファイルでソース管理できるツールが一応ある。 VBAしか知らない人にそのツールとgitの両方を覚えてもらうのは至難の業ですが。

[bonlife]

ここまでやってくれる人が増えることを祈ります。こういう手間にかかる工数考えず、書き捨てしちゃうことで見かけ上の効率化を実現できてたりするのがややこしいのよね。

[wwolf]

「わぁ...頑張ったんですね...」といった趣のExcel VBAを渡された時の事を思い返してしまうなど

[suika3417]

あきらめさせないためにやれって言う奴（上司）がいないとダメなんだろう

[d4-1977]

おろそかにしがちなので、改めて気をつけたい（自動化していきたい）

[nabinno]

コード管理：GitHubは敷居が高いので、私だったらバージョン機能があるesaに貼り付けてもらうかな / 質問の仕方：AWSサポートの問い合わせガイドラインを共有するようにしている

[ys0000]

お手製Excel VBAで引き継ぎができなくてカオスになるパターンはだいたいこの辺ができてないからで、バージョン管理とreadmeはやっぱり最低限欲しいよね。

[rryu]

どこで動いているのか、どう使うのか、何のためにあるのか、そして新規セットアップの方法が全て揃っていないと途絶えて使われなくなってしまう。

[rlho]

“特に非エンジニアの方々には、動くものがあればそれでいい、とも限らないことを覚えていただければと思います。コードの周りにある情報こそが重要です。・誰でも動かせる・安定して動かし続けることができる・継続

[cielonlon]

まずは描くべき理想。これをどこまでやるか、維持できるか。ひとまず真似るところからか？

[rx7]

大事なことが書いてあった。すごくわかりやすい。

[koogawa]

理想だ…！けど難易度は高そう

[Clock0311]

非エンジニアがこのような正しさに支払うコストを、その人の専門性に支払ったほうが勝てるチームになるケースは多いと思っているので、非エンジニアとエンジニアが組んで仕組みを作るほうに持っていきたい

[hamaco]

うっ…（カンファレンス用の自作ツールの使い方に毎回困っている人の顔）

[indication]

書き捨てだと思って組んだ物ほど使われるの、ツラい。

[als_uz]

だいじだ

[sue445]

いいはなし

[yujiorama]

「親しき中にも礼儀あり」的なリストだった

[sigwyg]

「5w1hのWhy」て言い方はいいと思った。Whyだけ言ってもいまいち伝わらなかったんだよね

[mashori]

そろそろ「why」を書き留めておかないとあかんな

[guni1192]

めちゃめちゃいい話だった

[matsumoto_r]

とても良い．僕も技術顧問などで経営者などにコードを書くとはどういうことかを説明するときにまず同じような話をする．正しく仕事のコードを書くというのはこういったプロセスの一要素に過ぎない．

[macj_jp]

非エンジニアに限らず、明日の自分は他人と思って自分のためのチェックリストにもできそう

[rarirurero9999]

VBAの適切な構成管理・適切なリリース方法を誰か教えて；；

[knosa]

関数ガチガチのエクセル作って仕事した気になってるそこのあなたに読んで欲しいやつ

[kagehiens]

端的にまとめられていて良いと思います。弊社visual sourcesafe使うのを止めてくれないんですがどうすればいいですかね……。

[strawberryhunter]

気持ちはわからないでもないけど、手を出すなって言っているようなものだな。

[Harnoncourt]

最新のソースがわかれば十分／自分はソースの頭にプログラムの目的だけコメントしている。ソースから内容が読み取れない人に仕事をさせたくないので、意識してハードルを上げる。

[iga_k]

うづらさんの文章、勉強になる

[Guro]

システム部隊は一日にしてならず

[door-s-dev]

多分できていない