OpsScriptMD

半自動化のためのドキュメンテーションツール

モチベーション

顧客へ安定したサービスを提供するためには、本番環境の運用作業で発生するミスをできるだけ減らすことが重要です。全ての運用作業が完全に自動化され、十分に検証されていれば理想的ですが、そもそも自動化されていなかったり、自動化された内容に不備があるかもしれません。

運用作業を半自動化することで手作業につきまとうヒューマンエラーのリスクを減らせます。もしくは、自動化された作業の全てが終わってから事故に気付くのではなく、各作業がうまくいったか人が確認しながら着実に作業を進めることができます。

このツールは Markdown で書かれた作業手順書内のスクリプトを直接実行できるようにすることで、運用作業の半自動化を実現します。

基本的な手順書の書き方は基本的な使い方を参照してください。

その他の手順書のサンプルは examples を参照してください。

いくつかの方法があります。

Markdown を左クリックし、「OpsScriptMD: Open OpsView」を選択します。

Markdown ドキュメントを編集中にタブバーのアイコンをクリックします。

Markdown ドキュメントを開いた状態で F1 キーを押下し、「OpsScriptMD: Open OpsView」を選択します。

スクリプトの領域にある再生ボタンをクリックするとスクリプトが実行されます。

コピーボタンをクリックするとスクリプトがクリップボードにコピーされます。

OpsView からうまくスクリプトを実行できないときに、他のツールでスクリプトを実行したい場合などに便利です。

CHANGELOG.md を確認してください。

OpsScriptMD は MIT ライセンスの下にリリースされています。