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

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

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

【初心者用】オブジェクト指向について初心者でもわかりやすくしてみた

オブジェクト指向とは、プログラミングの手法の一つです。 そもそも、プログラミングとは、「人間がコンピュータにやってほしいことを、コンピュータに分かる言葉を並べて指示を出す」ということです。 そして、その「指示」の出し方、表現の仕方は多岐にわたり、オブジェクト指向はその一つとなります。 オブジェクト指向、という言葉は、プログラミングの勉強をしているとよく聞くことになる言葉ですが、いざ説明するとなると、なにぶん「手法」の話なので、抽象的に、専門的になりがちです。 ここでは、そんなオブジェクト指向について、あくまで初心者の目線から分かりやすい表現で、ざっくりと説明しつつ、メリットやデメリットを説明していきたいと思います。

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

APIとは? API連携の仕組みやメリット、利用時の注意点をわかりやすく紹介

世の中にある多くのシステムやアプリケーションはAPIを通じて連携し、さまざまな業界や分野において利便性の高いサービスを実現しています。しかし、APIという言葉は聞いたことがあっても、具体的にAPIがどのような仕組みで、どのようなメリットをもたらすのか、利用者の立場では知る機会は少ないのではないでしょうか。この記事では、APIの基本的な仕組みから、API連携のメリット、そして利用時の注意点について詳しく解説しますので、APIを最大限に活用して、ビジネスにどのような効果があるのか知ってもらえれば幸いです。

学習・スキル

【入門】ネットワーク基礎知識まとめ！

現代において、スマートフォンやパソコンなどの通信機器は必要不可欠なものとなっています。あなたがスマートフォンやパソコンを使う時、主にどのような機能を使っていますか？…恐らくは、Webサイトの閲覧、SNS、オンラインゲームなどが多いでしょう。これらの機能は、通信機器同士が繋がっているために実現しており、この繋がりをネットワークと呼びます。今回はそんなネットワークについて、ネットワークとは何かから簡単な仕組みまで解説していきます。

開発環境関連(インフラ)

校内LANを整備しよう

近年、教育の情報化推進に伴い、学校におけるICT環境を整備する必要性が高まっています。学校という特殊な環境では、どの様に整備が進められているのでしょうか。今回は校内LANの整備についてまとめてみました。

その他(その他お役立ち情報)

Node.jsを使用したログイン処理の方法

今回はNode.jsを使用したログイン処理について学習していこうと思います。Webアプリケーションを作成する際に、ログイン処理は多用する事になると思うので学んでおいて損は無いと思います。

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

【初心者用】SQL インデックスとビューについてまとめてみた

参考サイト https://style.potepan.com/articles/25208.html SQLのインデックスとは? 作成、確認、削除方法からメリットまで解説! https://medium-company.com/sql-index/ SQL インデックス(INDEX)を作成・削除する http://dbonline.s25.xrea.com/sqlite/index/index3.html UNIQUEインデックス https://www.sejuku.net/blog/52356 SQL入門 PRIMARY KEY(主キー)制約とは? 追加や削除についても解説 https://style.potepan.com/articles/26878.html SQL 主キー(PRIMARY KEY)制約って何? サンプルコードで基本的な使い方を確認しよう! https://smallit.co.jp/blog/a1015/ BLOG SQLのビューについて https://products.sint.co.jp/siob/blog/view ビューとは? 使い方を解説 https://style.potepan.com/articles/25504.html SQLのビューって何? 基本的な使い方を理解しよう https://cs.wingarc.com/manual/drsum/5.5/ja/UUID-3b6e70a4-5a0d-205e-4b2b-fcb2df959cfd.html ALTER VIEW ビューの定義を変更する

製造・コーディング(SE)

PHPとは何？PHPエンジニアの年収や将来性もご紹介！

プログラマーとして就職活動を行ったのはいいものの、開発言語がたくさんあって自分がどの言語を学習し仕事にしていきたいか困っていませんでしょうか。当然ですが言語によって得意不得意の分野があり、自分が開発したいシステムによって使用する言語も異なってきます。また大半の会社は複数のプログラミング言語を使い分けてシステム開発をしております。処理内容やシステムが開発された時代によってプログラミング言語は変わっていくのです。そこで本記事では、プログラミング言語の１つであるPHPについてご紹介いたします。そもそもPHPとは何か、PHPの特徴やPHPが得意としている処理や将来性などをご紹介いたします。

【初心者】基本情報技術者試験とは

ITエンジニアを志す人向けの国家資格として、ITを活用する組織、教育機関から定評のある「基本情報技術者試験（FE）」。優秀なIT人材獲得競争に拍車がかかる今日、FE取得はITエンジニアのキャリアパスのきっかけになるかもしれません。本記事では、「基本情報技術者試験」の試験概要などについてご紹介します。

学習・スキル

Gitの使い方

ツールのアップデートが頻繁に行われているWEB業界では、Gitを活用して業務を効率化させることが一般的になってきています。しかし、初心者の方や業界に馴染みのない方は、Gitが何のことかわからない方もきっといらっしゃるでしょう。多くの開発者に利用されている印象のあるGitですが、実はエンジニアだけではなく、WEBデザイナーやライターにとっても便利なツールのひとつです。Gitを活用することで、チームでの作業効率を高めたり、多くのファイルを管理することが簡単になります。というわけで本記事では、Gitについて基本的な用語について解説いたします。

学習・スキル

単体テストとは

単体テスト(ユニットテストと呼ばれることもあります)は、プログラムを構成する比較的小さな単位(ユニット)が個々の機能を正しく果たしているかどうかを検証するテストです。通常、関数やメソッドが単体テストの単位(ユニット)となります。 プログラムが全体として正しく動作しているかを検証する結合テストは、開発の比較的後の段階でQAチームなどによって行なわれることが多いのとは対照的に、単体テストは、コード作成時などの早い段階で開発者によって実施されることが多いのが特徴です。

初心者

【初心者用】Docker（ドッカー）とは？

Dockerは今や当たり前に使われているプラットフォームですが、実務で使用することになったため、今更ながら自分なりに調べてまとめてみました。

開発環境関連(PG/バックエンド)