見出し画像

ドキュメントとコードが一つにまとまったら

Haru

私は製造業社内SEとして6年ほど働いています。前職はシステムインテグレーターで５年ほどSEをやっていました。

この11年間、ドキュメントは嫌というほど書きました。定期的に実施する作業手順書、システムの環境移行手順書、環境構築手順書。要件定義書や設計書、テストシナリオはもちろんです。

これらは全てドキュメントですが、SEという仕事柄、どうしてもコードと密接に関係します。

ドキュメントに書かれてるプログラムを実行する、設定を変更するのが、面倒くさい

手順書系のドキュメントは特にそうですが、手順書の中に「●●●プログラムを実行する」という文章が出ます。実行ではなくても、「●●●の設定を▲▲▲に変更する」という記述もよくあります。

PCなんだから自動でやってよ、と思いたくなりますが、見ているのはただの手順書でありソフトウェアではありませんので、仕方ありません。手を動かせるのは、その手順書を読んでいる人だけです。

手順書にコードを書いて、ワンクリックで実行できたら

どうせ実行するプログラムや設定箇所が決まってるのであれば、手順書から呼び出せた方がラクです。わざわざ、「実行するプログラム名があってるか？」「設定箇所は間違ってないか？」と確認する手間が省けます。決まったことしかしないのが手順書なので、徹底的にラクをするべきです。

ExecNote

このような「ドキュメント＋コード実行」を実現させるために、ExecNoteというアプリケーションを開発しました。

画像1

https://execnote.app/

このアプリケーションは、　Markdownの中に記述したソースコードをワンクリックで実行できます。

現在は、PowerShell, Python, NodeJSのコード実行に対応しています。

ExecNoteが解決したもの

ExecNoteを使って手順書を書くと、もれなくコード実行機能がついてきます。簡単な操作であれば、手作業で操作するよりもワンクリックでコードを実行したほうが、時間短縮にもなり、作業品質も向上します。

作業を自動化する手法としては、RPAやAIなど様々な方法があります。しかし、どれも高価でありそれなりに学習コストもかかるため、運用開始までに時間がかかります。

しかし、ExecNoteであれば、書いたコードをそのまま実行するため、学習コストはほぼゼロです。コードを書ける人はコードを書いたほうが手っ取り早いと感じることが多々あると思い、それを実現するためのアプリケーションになってます。

私について

冒頭でもふれましたが、私は１１年間システムエンジニアとして働いてきました。COBOLからC#、JavaScriptなどを使っていろんなアプリケーションを開発してきました。現在は自動車部品製造業の社内SEでほとんどシステム設計・開発をしています。

ブログは https://usefuledge.com/ に書いてます。主にプログラミングなど技術的な情報ばかり書いてます。

Twitter https://twitter.com/Harus0313 は、思ったことや感じたこと、ExecNoteの開発状況をツイートしています。ExecNoteの問い合わせもこちらで受け付けています。

最後に

アプリケーション開発者としては、ユーザーからの改善要望や感想をいただくことが大変励みになります。

拙作ですが、ExecNoteをどうぞよろしくお願い致します。

画像1

https://execnote.app/

この記事が気に入ったらサポートをしてみませんか？