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

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

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

【セキュリティ】脅威と対策

昨今、リモートワークの普及によりVPNの使用に関するインシデントも増えているようです。また、攻撃が巧妙化しているのもあり、セキュリティ問題について考える機会も多くなってきました。どんな脅威が増えているのか、またその対策などについて学習していきます。

テスト(IT事務全般)

マークアップ言語でなにができる？その種類と活用法を紹介！

マークアップ言語とは、文書の構造や見た目を表現するための言語のことで、HTMLやXMLなどが有名です。マークアップ言語は、プログラミング言語とは異なり、命令や計算を行うことはできませんが、文書の意味やレイアウトを定義することができます。この記事では、マークアップ言語の特徴やできること、プログラミング言語との違いなどを紹介しながら、マークアップ言語の種類や用途についても説明していきます。

javascript 基本文法4

javascript 基本文法について

初心者

テスト計画書とは？作成する理由や記載必須の内容について教えます！

開発プロセスにおけるテストとは、そのソフトウェアの品質を決める重要なファクターとなっております。テストを正しく実施することはそのまま品質を上げることになります。テストとはいっても、ただやるだけではなく、事前に計画を立てて無理のないスケジューリングを行った上で実施する必要があります。そこで今回はテストにおけるテスト計画書の作成方法やテスト設計所との違い、なぜ必要であるかをご説明いたします。

学習・スキル

システム開発のテスト工程で重要な事とは？

システム開発では、不具合やバグが無いかを検証するテスト工程と呼ばれる期間が存在します。 テスト工程には大きく分けて下記4つのテスト内容が存在します。 ・単体テスト・・画面や機能ごとに、動作の検証をする ・結合テスト・・他の機能やシステムと連携させて、動作の検証をする ・総合テスト・・本運用を想定して、システム全体の動作を検証する・ 受入れテスト・・納品前に仕様書の通り完成しているか確認する システム開発におけるテストの役割は、開発したシステム、記述したプログラムが不具合なく動作するか、バグなどがないかをチェックして修正する工程のことを指します。 どれだけ優秀なエンジニアが開発していようと、人の手が介在するシステム開発では、バグがないということは絶対にあり得ません。 たとえば、システム開発の現場でもっともポピュラーな開発の流れの「ウォーターフォール型」を採用している場合、「単体テスト」「結合テスト」「システムテスト（総合テスト）」「受け入れテスト（ユーザーテスト）」の、大きく4つのテスト工程が実施されます。

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

DX化を加速させるローコード開発とは？

昨今、様々な外的要因により企業をとりまくビジネス環境の変化が大きく加速しています。 これまでと比べて、より柔軟に、よりスピード感を持った迅速な対応が求められる時代になってきているのではないでしょうか。 そんな中、企業のあらゆるニーズに応え、ITをビジネスの成果に直結させる手段としてここ数年で「ローコード開発」というシステム開発の手法が注目されています。 今回の記事では、ローコード開発とはどのようなものなのか、従来の開発手法との違いやメリット・デメリットなどと併せて紹介していこうと思います。

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

イチから学ぶデータベース・SQL（１１）

イチから学ぶデータベース・SQL（１０）では、CASE式について学習していきました。 今回も、これまでと同様paizaラーニングを参考に、オンラインRPGを題材としてSQLについて学習していきます。

製造・コーディング(インフラ)

【初心者用】C#とは

C#は少しだけ実務で経験しましたが、経験としては浅いため今回知見を広げるために、改めてC＃について学んでみようと思います。業務システムやモバイル、据え置きなどのゲーム開発でも使用されているので、覚えておくことで今後の選択肢の一つとして選べるようにしておきます。

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

【通信プロトコル】SSL/TLSについて

みなさんは、httpやhttpsなどをよく目にすると思います。このhttpやhttpsのことをプロトコルといいます。今回はそのプロトコルについて解説するのですが、プロトコルにはかなり沢山の種類があります。その中で「SSL/TLS」について、本日はご紹介していきます。プロトコルとは何かというところから、この「SSL/TLS」がどういった場面で使用されているのかを具体例をあげながら紹介していきます。

学習・スキル

インフラエンジニアのキャリアアップに必要な資格とは？難易度別にご紹介！

インフラエンジニアとして活躍される方々の中には、社内の保守・運用案件に配属され、やりがいを感じながらも、日々ルーティンワークに追われて成長を実感できず、将来に不安を抱く方もいらっしゃるかもしれません。そこで、本記事では、そのような方に向けて、インフラエンジニアのキャリアアップに必要な資格についてご紹介します。

学習・スキル

【C# WPF】WPFを理解したいC#初心者の話【MVVMパターン編その2】

C# WPFについて学んでいく過程を備忘録として残して置きたいと思います。

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