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

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

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

インフラエンジニア向け！Shellスクリプトの種類とその魅力

インフラエンジニアの道を歩み始めたばかりの皆さん、シェルスクリプトという言葉をすでに耳にされたでしょうか。シェルスクリプトは、システムやネットワークの設定、管理、自動化など、インフラの様々なタスクを効率よくこなすための強力なツールです。しかし、その機能や種類について深く知らない方も少なくないでしょう。本記事では、シェルとシェルスクリプトの基本的な概念から、主なシェルの種類（sh系とcsh系）、シェルスクリプトで実現できるタスク、そしてシェルスクリプトの重要性について詳細に解説します。また、シェルスクリプトの学習を通じて、自身の技術力向上やキャリア発展にどう寄与できるかについても触れます。シェルスクリプトの知識が浅い方、さらに深い理解を求めている方、ぜひ本記事を参考にして、スキルのブラッシュアップを図ってください。

【JavaとJavaScript】プログラミング言語の違いと選び方

プログラミングの世界に足を踏み入れようとする際、最初に直面する疑問の1つは、どのプログラミング言語を学ぶべきかということでしょう。特に初心者の場合、JavaとJavaScriptの2つの言語は名前が似ていることから混同されることがありますが、実際には全く異なる特性と用途を持つ言語です。本記事では、JavaとJavaScriptの違いを明らかにし、それぞれの言語の特徴や学習のメリットについて探求していきます。

【初心者目線】Webアプリケーションの開発 第5回

【初心者目線】Webアプリケーションの開発 第5回について書きます。

PythonでWebアプリケーションを作成するための備忘録

近年AIやディープラーニングの盛り上がりで注目されているPythonですが、特徴、できること、学習方法、Webアプリケーション構築に適しているのかを調べてみました。

【初心者向け】情報セキュリティの基礎

IT業界で働くうえでかかせない、情報セキュリティについてまとめました。情報セキュリティの知識が不足していると、重大なセキュリティ事故を起こし、損害賠償などになりかねません。ぜひ気を引き締めて最後までお読みください！

iOSエンジニアとは？仕事内容・必要なスキル・おすすめな資格をご紹介

現在、多くの方がスマートフォンで日常生活の連絡や情報収集、ゲームを楽しんでいます。そして、そこからスマートフォンアプリを作れるエンジニアの需要は高まっています。とくに、日本で利用者が多いiPhoneのアプリケーションを作ることができるiOSエンジニアは需要が非常に高いです。しかし、iOSエンジニアの具体的な仕事内容や活躍するために必要なスキルはなかなか分からないですよね。そこで、ここではiOSエンジニアの仕事内容と必要なスキルにくわえ、おすすめな資格についてもご紹介します。これからエンジニアとして活躍を目指そうとお考えの方は、ぜひご確認ください。

【初心者】基本情報はおすすめ

「基本情報（FE）レベルの知識がある人材がほしい」私が経験半年の駆け出しエンジニアの頃、転職活動の際に言われた言葉です。「学生のうちにITパスポートと基本情報を取っておけば就活で評価される」私が学生（情報理工系、偏差値45ぐらい）の時にとある教授が口酸っぱく言っていました。「ITパスポートも大事だけど取得していてもあまりネタにされない」「未経験のエンジニアは基本情報を取って初めて評価されるみたいな」エンジニアが集う交流会で会った、実務5年以上の先輩が言っていました。この”基本情報”という資格、結構大事だそうです。本記事では、基本情報はおすすめだということを話していきます。

【基本】MYSQLの使い方

今回は私がよく現場で使用している「MySQL」について再度復習をしました。

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

テスト自動化

テスト自動化とは、人の手によって行われるソフトウェアテストの全体あるいは一部を自動化することを意味します。そもそもソフトウェアテストは、不具合を見つけることが目的です。そのため、テストを繰り返し行うことも増えています。テスト自動化によって、テストにかかる人的負担を減らし、将来的なコストの削減が期待できます。テストといっても、その中にはさまざまなプロセスが含まれます。ソフトウェアテスト技術者資格認定組織である「ISTQB（国際ソフトウェアテスト資格認定委員会）／JSTQB（日本ソフトウェアテスト技術者資格認定組織）」の定義によると、テストプロセスは以下の5つの要素で構成されています。テストプロセス　・テスト計画作業とコントロール　・テストの分析と設計　・テストの実装と実行　・終了基準の評価とレポート　・終了作業

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

【ソフトウェアテスト】同値分割法/境界値分析

入力されるデータによって判定を変えるという機能は、ソフトウェアの機能として広く一般的に使われます。自己責任で金銭を扱うサービスを利用する際には、18歳以上か未満かで利用の可不可を判定するという年齢確認機能が適用されていることがあります。ユーザーが任意にパスワードを設定できる機能の場合は、文字数が想定より少ない場合はセキュリティレベルが低いため無効として、文字数が想定より多い場合も仕様想定外として無効とするシステムもあります。こういった機能を対象に検証を実施する際、入力可能な数値を全て検証対象としてテストを実施しようとすると、非常に多くの工数を割かねばならないため、入力想定範囲の中で同じ処理を返す想定の数値は1つのグループとして扱い、処理の変わる境目に狙いを付けてテストするというのが、「同値分割法」と「境界値分析」です。

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

【ソフトウェアテスト】クラシフィケーションツリー技法

クラシフィケーションツリー技法は主に、複数のテスト対象と各対象の値が複数関連する状況で、各対象を木構造で図示することで、テスト対象の機能や状態を階層的に分類し、その組み合わせや変数いくつ分を対象とするか等の組み合わせの強度について、整理検討するときに用いる技法です。ドメイン分析テスト技法の際には、複数の境界値による動作変化の関連性と、その組み合わせで想定される複数パターンの網羅を表形式で表現する方法を取りましたが、クラシフィケーションツリー技法では、1つの機能に関わる複数の要素、各要素に想定される複数パターン、各パターンで想定される変数のパターンと、想定される内容を木構造の図で上から下へ記載して整理する方法を取ります。ブラウザベースでWebサイトを作成して、ウィンドウの表示サイズをPCサイズのレイアウトとスマホサイズのレイアウトで2パターン適用するとして、PCサイズレイアウトが正常に適用されているかを確認するときのテストスコープについて、ブラウザは[GoogleChrome][MicrosoftEdge][Firefox][Safari]をテスト対象と仮定し、各ブラウザのサイズや文字サイズ設定を変更しても問題ないか、さらに設定するウィンドウサイズは想定の最小値・最大値・全画面のパターンで、文字サイズは通常から何％拡大を対象とするかなどを考慮し、どの組み合わせでのテストを必要とするかを検討するといったような場合には、当該技法を用いることで視覚的に情報を整理しやすくなります。

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