マニュアル作成で心がけることとは

皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い（アップデートされていない） 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。

製造・コーディング(PG/バックエンド)

【Git】基礎まとめ | 初心者向け

今回はバージョン管理システムのGitについてまとめました。Gitを使用すると、より効率的にシステムを開発することができます。ぜひ最後までお読みください！

その他(SE)

【初心者向け】様々なシステム開発手法

システム開発には作成するサービスやプロジェクトによって適切な開発手法がいくつかあります。今回はシステム開発の手法を数種類紹介して、それぞれの特徴や、メリット、デメリットを紹介します。下記が主な開発手法の一覧になります。　・ウォーターフォール型開発　・アジャイル型開発　・プロトタイプ型開発　・スパイラル型開発　・DevOps（デブオプス）　・リーン開発では次からそれぞれの開発手法の特徴とメリット、デメリットを紹介します。

GitHub Actions でCIテスト・デプロイハンズオン

アジャイル開発ではスプリントを決めて開発を行い、修正を都度対応する必要があるため、スピード感を求められる開発現場が多い。そのため、継続的インテグレーション（CI）や継続的デリバリー/継続的デプロイ（CD)を導入し、マージやデプロイのコストを下げ、効率的な開発を実施したいが、初期導入コストや学習コストなど様々な観点から実施が見送られるケースも少なくない。今回はCI/CDを学習し、プロジェクトに対して現実的に導入する際のメリット・デメリットに関して言及していきます。

その他(PG/バックエンド)

【五日目】Java学習

Java学習5日目

製造・コーディング(PG/バックエンド)

便利な【AWS】について

皆様はAWSという単語を耳にしたことはありますか。クラウドサービス世界シェア1位のAWSについて、何が便利なのか、何ができるのか、どうして使用されるのか、そういった理由をAWSにはじめて触る人にもわかりやすく調査してまとめてみました。

【ソフトウェアテスト】不具合報告のインシデントレポートについて

開発プロジェクトで発生した問題はインシデントとして、管理・分析・対応が必要です。プロジェクト全体を通しての問題となるとかなり範囲は広く、人的トラブルやステークホルダー間での問題など、開発しているプロダクト以外の問題も含んでしまうので、本記事では主にプロダクトのテストに関して検出された動作の不具合(バグ)に焦点を絞って記載します。プロダクトのテストに際して検出した不具合は、報告・対応したあとは蓄積データとして、引き続きプロジェクトで参照・活用されます。実際の開発現場によっては、早期レビューでのやりとりに関するものや、開発とテスターが口頭で連携できるような状況で報告即時対応できる程度の不具合対応など、状況により必ずしも定められたドキュメントの形式で報告されるものとは限りませんが、可能な限り検出対応した不具合は履歴を残しておくことで、プロダクトの品質向上を目指すことができます。ほとんどの場合は不具合管理に別途外部のbug tracking system（BTS）を使用しています。BTSはインシデントレポート1件をチケットという1単位で扱います。チケットの形式や内容が必ずしも同一の形式に沿っているというものではありませんが、不具合の報告管理をするチケットの内容は、管理運用の観点から記載が必要となる項目はある程度決まっています。余談ですが、BTSは不具合報告のみならず、チケット駆動開発 (TiDD) を実施するプロジェクトでは開発作業自体の管理進行目的で使用される場合もあります。

テスト(運用・保守・サポート)

【ソフトウェアテスト】CFD法

CFD法はCause Flow Diagram(原因流れ図)を略したもので、原因の集合と結果をそれぞれの関係のつながりにフォーカスして図式化し、そこからデシジョンテーブルを想定してテストケースを作成する技法です。システム設計において、正常な動作の仕様を基本として異常系の仕様もエラー動作実装のため明確に定義されているべきですが、テスト実施の際には、仕様想定上の正常系・異常系動作確認はもとより、考え得る限りの準正常系テストケース網羅も必要です。そうしたケースの考慮が足りていないと、リリース後にユーザーが想定外の操作を実行して重篤な不具合につながったり、あるいは仕様の穴を付いた不正処理などを実行されたりして、プロジェクトやサービスに損失が発生したりします。原因・結果・各関係を図示して明確に関係を洗い出すことで、実装段階では考慮が漏れているような挙動についても抜けや漏れをカバーするようにテストすることができます。また、エラーに関するもののみではなく、同値分割が可能な原因が複数関連して複数の結果が想定されるというシステムで、その関係性を図にして流れを見ることで、テストケース作成がグラフィカルに把握しやすくなります。インターネットでクレジットカードを利用して決済処理を実行する際に、完了までには以下の様な結果パターンが想定されます。・カード情報入力エラー(入力したカード利用情報に問題がある)・決済処理不能エラー(登録しているカード情報の照会時にエラーが発生)・通信不良による接続タイムアウトエラー(決済実行から完了までの通信時間が規定の時間内に処理されないことによるエラー)・決済完了上記4パターンの結果を返すまでの原因は、細部まで書き出すと煩雑になります。・複数の入力フォームに入力した情報のどこがエラーになったか・カード情報照会時にどのような理由でエラーになったか・どのページからどのページに遷移するときにエラーになったか・何秒以上の通信待機時間を過ぎたら通信エラーで処理するか等これらを一つの枠に収めてそれぞれを線でつなぐことで関係性を整理できるのが、このCFD法の利点だと思います。

テスト(運用・保守・サポート)

【初心者用】SQLのクエリ操作基礎2

タイトル通りですが、SQL初心者がクエリ操作に関して学んだことまとめていきます。操作方法について忘れていることが分からないことが多いので、クエリ操作について基礎を学んでいきます。

その他(PG/バックエンド)

機械学習エンジニアのキャリアパスと必要なスキルについて

機械学習は近年、急速に発展している分野であり、多くの企業や産業において重要な役割を果たしています。機械学習エンジニアは、データを分析し、予測モデルを開発するなど、機械学習技術を活用して問題を解決する専門家です。本記事では、機械学習エンジニアとしてのキャリアパスや、成功するために必要なスキルについて探っていきます。経験の浅い方々やキャリアを考えている方々にとって、参考になる情報を提供します。さあ、機械学習エンジニアとしての旅を始めましょう。

データベースエンジニアの仕事内容や求められるスキルをご紹介！

データベースエンジニアとはデータベースと言う膨大なデータを管理するためのツールを扱うスペシャリストのことを指します。データベースは、アプリケーション開発やシステム開発にとってなくてはならないツールとなります。アプリケーションやシステムは必ずデータベースと連携して動作しています。具体的には、顧客情報を管理したりマスター情報と呼ばれるアプリケーションで使う設定値を管理したりしています。データベースは各テーブル間の整合性を保つ必要があります。そのためにはデータベース設計を行う必要があります。データベース設計は、プログラム開発やプログラム設計と同じくらい重要な役割を担っており、専門性が必要とされます。そこで今回はデータベースエンジニアの仕事であったり、必要なスキルや知識をご紹介していきます。データベースエンジニアを目指している場合は、ぜひこの記事を見て参考にしてください。

【Swift】MVPアーキテクチャの簡単なサンプル【iOS】

今回はModel-View-Presenter[MVP]アーキテクチャのデザインパターンで簡単なサンプルを作成します。ModelではDBやAPIアクセスの処理、Presenterではその他の処理、描画はViewで行う考え方に基づき実装しました。これから作るサンプルではModel内でRealmSwiftを使用します。環境・MacOS Ventura 13.0・Xcode 14.2・Swift version 5.7.2

製造・コーディング(PG/フロントエンド)