【擬似コード】使ってみたら手戻りが減った

擬似コードとは

擬似コードとは、本来PythonやGolangといったプログラミング言語で記述をする処理を自然言語で記述したものを指します。
もちろん自然言語処理で記述しているため、コードの実行はできません。（なので「擬似」と呼ばれます）

擬似コードのメリット

1. アルゴリズムの明確化
   擬似コードは、自然言語とプログラミング言語の中間の言語として機能し、アルゴリズムのロジックを明確に伝えられます。これにより、プログラムの動作を理解しやすくなり、誤解を避けられます。

2. 言語依存性の回避
   擬似コードは特定のプログラミング言語に依存せず、異なる言語での実装においても基本的なアルゴリズムの構造を維持できます。これにより、プログラマ間での知識の共有が容易になります。

3. プログラム設計の初期段階での活用
   擬似コードは、プログラム設計の初期段階で用いることにより、開発者がロジックの正確性を検証し、潜在的な問題を早期に発見する手助けとなります。これにより、開発プロセスの効率が向上します。

4. コードレビューの効率化
   擬似コードは、コードレビュー時にアルゴリズムの理解を助けます。詳細な実装に入る前に、アルゴリズムの正確性を確認するための基礎として機能するので、要件の間違いなどを防ぐこともできます。

5. プロトタイピングの迅速化
   プロトタイプ開発時に、擬似コードを用いることで、迅速にアルゴリズムのアイデアを検証できます。これにより、実装における無駄な作業（設計の勘違いによる手戻り）を削減し、チームメンバー間で迅速なフィードバックを得ることが可能になります。

擬似コード例

ワークフローのトリガー:
このワークフローは、リポジトリの main または develop ブランチにコードがプッシュされたときに開始されます。

ジョブ 1: コードのビルドとテスト

コードのチェックアウト: 最新のコードをリポジトリから取得します。
環境のセットアップ: テストとビルドに必要な環境を設定します（例: Node.jsのインストール）。
依存関係のインストール: プロジェクトに必要なパッケージやライブラリをインストールします。
ユニットテストの実行: コードの品質と動作を確認するためにユニットテストを実行します。
ジョブ 2: プロジェクトのビルド

コードのチェックアウト: 最新のコードを再度取得します。
ビルドの実行: プロジェクトをビルドして、実行可能な状態にします。
ジョブ 3: デプロイ

コードのチェックアウト: デプロイ用に最新のコードを再度取得します。
デプロイの実行: 構築されたアーティファクトを本番環境にデプロイします。デプロイスクリプトや特定のツールを使用して、サーバーやクラウド環境にアプリケーションを配置します。
通知:

成功/失敗の通知: ワークフローの実行結果（成功または失敗）に応じて、チームに通知を送ります。

まとめ

擬似コードは、プログラムのロジックを明確にし、異なる言語間での移行を容易にする有効なツールでした！
上記のような擬似コードを空PR作成時点でレビューしていただき、相違ないことを確認した上で実装を行なっているので、手戻りが減りました。

これからも活用しつつ頑張ります...。