マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い（アップデートされていない） 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
製造・コーディング(PG/バックエンド)
テストエンジニアについて
IT業界で働く際には、できる限り自分に合った職種で働くことが大切です。そこには多種多様な職種があり、その仕事内容や求められるスキルも様々です。なので、実際に仕事を探す際には、個々の職種の違いが何であるかをしっかりと理解しておくことが必要になります。そこで本記事では、「テストエンジニア」という他のエンジニア職とは少し毛色の変わった職種を紹介したいと思います。
キャリア
【初心者用】手軽なPython開発環境の構築方法
これからプログラミングを学ぼうと考えている初学者の方の第一の壁は、環境構築ではないでしょうか。 プログラムを実行するためには、プログラムに適した環境（空間）をパソコン内に構築する必要があり、学ぶ言語によって環境構築の方法は異なります。 今回は、昨今人気のPythonのプログラムを実行するための環境構築で、筆者が一番楽だと感じた方法について紹介していきます！
製造・コーディング(PG/バックエンド)
【Java基礎】Java未経験から習得を目指す 環境構築編
どうも、C++が最も得意なプログラマです。仕事の関係でJavaを扱うことになったのですが、Javaに関しては全くの未経験ですので、今回からJavaについて学んでいこうかと思います。
製造・コーディング(PG/フロントエンド)
テスト技法と種類
テスト技法とは、ソフトウェアテストのテストケースを作成するための技法です。同値分割法、境界値分析、デシジョンテーブルテストなど、さまざまなテスト技法が存在します。テスト技法を利用することで、テストケースの抜け漏れを防いだり、効率よくテストケースを作成することができます。
初心者
【Java】文書の読込み・出力方法
システム開発をしていると、ファイル入出力の処理機能を実装する場合があると思います。ただ、初心者の方はファイル入出力とはどういうことなのか分からないと思う方もいると思うので、今回はファイル入出力とはどういうものか、どのような時に使うのか、どのように実装するのかを順に解説していきます。
初心者
【HTML】さまざまなタグ | Part 2
今回は、HTMLのさまざまなタグについてまとめました。HTMLは、Web開発をするにあたって欠かせない知識となっています。ぜひ最後までお読みください！
製造・コーディング(PG/フロントエンド)
AADとAADCについて
Azure Active Directory(以下Azure AD)とは、Microsoftが提供するクラウドベースで「認証」と「許可」を一元管理するサービスです。Azure ADで認証を行えば、連携しているシステムにログインなしでアクセスできるようになります。Azureアカウントで、他のクラウドサービスが利用できます。例：Dropbox、Slackなど
その他(インフラ)
【初心者用】SQLの書き方・用途などまとめ
SQLはデータベースを操作するための言語です。SQLを使うことでデータベースにデータを挿入したり、検索したりといった操作を効率的に行うことが可能です。本記事ではSQLの基礎構文、用途、サンプルコードをまとめていきます。なお、説明の便宜上、以下の表のデータを使用します。
学習・スキル
基本情報技術者試験は意味ないはウソ？資格取得のメリット・試験概要・難易度を解説！
IT業界に携わるビジネスパーソンや、これからITスキルを身につけたいエンジニア候補生にとって、基本情報技術者試験は最初に挑戦したい国家試験の一つです。しかし、基本情報技術者試験は難易度が高く、合格率も低いというイメージがあります。また、最近では学校や会社で薦められて基本情報技術者試験を取得したが、全く使うシーンがなく意味がないといった声も聞きます。この記事では、なぜ意味がないと言われるのか、その理由や、エンジニアにとってのメリット、基本情報技術者試験の概要や難易度・合格方法を解説します。
学習・スキル
CIとは何か？代表的なCIツールの特徴とメリット・デメリットを解説
CIとは、開発者がコードを頻繁に統合し、自動的にテストやビルドを行うことで、品質や効率を向上させる手法です。 CIを実現するためには、CIツールと呼ばれる専用のソフトウェアが必要です。 CIツールは、コードの変更を検知し、自動的にテストやビルドを実行し、結果を報告する機能を提供します。しかし、CIツールには様々な種類があり、それぞれに特徴やメリット・デメリットがあります。 では、どのようにしてCIツールを選ぶべきでしょうか？ この記事では、代表的なCIツールの概要と選び方について解説します。
学習・スキル
C言語は将来性がある？C言語の特徴も解説！
現在ではプログラミングを身につけることによって、収入面やキャリア面が向上すると言われています。キャリアアップや転職を考えている上で、どのプログラミングを選択したら良いか悩んでいる方もいらっしゃるのではないでしょうか。その中でも、C言語は汎用性が高く需要も高いプログラミング言語です。しかし、C言語の特性やメリットを理解していないと、自身が思うようなキャリアアップへ繋がらないことも事実です。今回は、C言語をキャリアアップへ最大限に活かすために、C言語の基本や特徴をご紹介します。
初心者
関連タグ
カテゴリ別人気記事
もっと見るテレワーク関連人気記事
2023年10月02日
製造・コーディング(PG/フロントエンド)2023年07月18日
アーキテクト・技術選定(PG/バックエンド)2023年11月17日
学習・スキル2023年10月26日
テスト(運用・保守・サポート)2023年01月09日
詳細設計(内部設計)(インフラ)
週間人気記事
もっと見るGit GUIツールの使い方：初心者向けチュートリアル
Gitとは、分散型バージョン管理システムの1つで、コードやファイルなどの変更履歴を記録し、複数の人で同時に開発を進めるために使われます。Linuxの開発者であるLinus Torvaldsによって開発され、現在は世界中の多くの企業やオープンソースプロジェクトで使用されています。Gitは、ファイルの変更履歴を保存するための「リポジトリ」と呼ばれるデータベースを持ち、このリポジトリに対してコミットと呼ばれる操作で変更履歴を追加していきます。また、ブランチと呼ばれる分岐を作成して、異なるバージョンのコードを管理します。Gitの主な特徴としては、以下のようなものが挙げられます。・ローカルでの高速な動作・分散型であるため、オフラインでも開発ができる・変更履歴を管理しやすく、コードの品質を高めることができる・大規模なプロジェクトでもスケーラブルに対応可能Gitは、コマンドラインツールを使って操作することもできますが、GUIツールを使って操作することもできます。
アーキテクト・技術選定(PG/バックエンド)
【これからJP1に触れる人向け】JP1とは
開発プロジェクトに携わる際にJP1というツールに触れたことはあるだろうか。JP1は開発工程、特にテスト作業においては非常に利便性の高いツールである。この記事ではまだJP1に触れたことがない人向けにJP1の概要やJP1を合う買う際に知っておくべき用語を取り上げる。
テスト(運用・保守・サポート)
DBのビューとは？メリットデメリットや使用方法についても紹介！
アプリケーション開発にとってデータベースは必須スキルとなっております。データベースの知識がないと、アプリケーション開発に難航することでしょう。しかしデータベースの知識を身に付けるとなると、かなりの勉強量を要します。というのもデータベースオブジェクトには様々な種類があり、一朝一夕では身に付くものではありません。今回は、データベースのビューについてご説明いたします。ビューそのものは必ず覚えてなくてはならないと言うものではありませんが、よく使われます。まずは本記事でビューの基礎知識を身に付けてください。本記事ではメリットデメリットや具体的な使用方法について紹介しております。
学習・スキル
【初心者向け】Packet Tracerでネットワークを学ぶ（NAT）
NATとはNetwork Address Translationの略称でIPアドレスを変換する技術です。 インターネットに接続する際にプライベートIPアドレスをグローバルIPアドレスに変換します。
詳細設計(内部設計)(インフラ)
AUTOSARについて、まとめてみた
AUTOSAR(オートザー)とは、Automotive Open System Architectureの略称で、車載ソフトウェアの共通化を実現するためのプラットフォームの仕様名称でもあります。
開発環境関連(PG/フロントエンド)
【初心者向け】不具合報告書の書き方
テストエンジニアは業務内で不具合を見つけた際に不具合報告書を起票することになります。不具合報告書とは、発生した不具合の原因と対策について記載した文書です。社内の関係者への共有はもちろん、取引先に提出することもあるため、正確かつわかりやすく記載する必要があります。
初心者
インデックスとは？メリットデメリットやインデックスの種類も交えてご紹介
インデックスとは、データベースを扱う際には欠かすことのできない概念となります。インデックスの取り扱いによって、データのアクセス速度が大きく変わります。特に大規模なデータを扱う場合には、取り扱いに気をつけなくてはなりません。インデックスを設定した結果、処理速度が遅くなってしまうことやそもそもインデックスを使用するような実行計画が選択されないこともあるのです。インデックスは、DBMSの種類（例えば、OracleやMySQL、Postgreなど）によっても異なります。インデックスの仕様を知らないと、開発者にとって意図しない処理をしてしまう可能性もあります。そこで今回はインデックスについてメリットデメリットや具体的にどのような種類があるのかを説明していきます。
学習・スキル