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

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

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

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

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

【五日目】Java学習

Java学習5日目

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

【初心者向け】Packet Tracerでネットワークを学ぶ（インストール編）

ネットワークエンジニアとしてCisco社のルータやスイッチの運用業務を遂行するには、 コマンドの知識やどのように機器が通信させているかよく理解しておく必要があります。 またCCNAといったネットワークのベンダー資格でも実際にコマンドを記述するシミュレーション問題が出題されることもあるので、自身のネットワークスキル向上には日頃からコマンド操作に慣れておく必要があります。 知識を定着や操作の慣れには座学だけでなく実際に機器に触れコマンドを入力し結果を確認することが一番なのですが、ルータやスイッチ等のネットワーク機器はいずれも高額であり、中古でもそれなりの値段となるので初心者が自宅に環境を作成することは簡単ではありません。 そこでCisco社のルータやスイッチに簡単に機器の設定、環境の構築、コマンドの投入練習といったことができるアプリケーションが「Packet Tracer」となります。

詳細設計(内部設計)(インフラ)

「IT向いてない」と言われたけどエンジニアになりたい人向け記事

「学校の授業にはついていけていたのに」「プログラミングになると頭が痛くなる」「実際にIT向いてないと言われた」「でもエンジニアとして働きたい」こんな人向けの記事です。

【ソフトウェアテスト】ソフトウェア開発とテスト活動について②

「【ソフトウェアテスト】テストレベルについて　①」記事に記載のとおり、開発ライフサイクルモデルには形式や期間によってさまざまなモデルがあり、テストを実施するタイミングもモデルによってさまざまです。先に挙げた開発工程の例である要件定義→設計→開発→テスト→リリース/保守を一連の流れとする開発ライフサイクルも、このフローを開発期間の流れとして実施するのはあくまでウォーターフォール型モデルのようなシーケンシャルな開発ライフサイクルであり、イテレーティブ開発モデルやインクリメンタル開発モデルでは、各工程とテストが同時に進行したり、無駄をなくすことを目的としてあえて一部工程を省くこともあります。V字モデルは各工程とテストが同時進行する例です。要件定義の段階で要件定義に対するテストを実施、システム設計の時点で設計された内容に対してテストを実施といったかたちで、開発完了後にようやくテストではなく、常に工程の早期段階でテストを実施します。開発完了後のテストで不具合が検出されると工程の手戻りが発生してしまい、工数に無駄が生じますが、早期にテストを実施することにより、上流工程の段階で不具合や懸念を可能な限り取り去って開発作業の手戻りを少なくし、無駄な工数の増加を防いだり、最終的な品質の向上を目指すことができます。このようにV字モデルの左側で行う開発活動に対して早期にテストを実施して効率的な開発活動を目指す手法をシフトレフトと呼びます。イテレーティブ開発モデルやインクリメンタル開発モデルとなると、さらに各工程とテストが早期段階で実施されていきます。全体的な流れをより細かく迅速に行い、それを細かく繰り返していくサイクルが、現在のソフトウェア開発形式の主流になってきています。

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

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

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

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

初心者PHP講座

初心者PHP講座

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

【HTML】さまざまなタグ | Part 1

今回は、マークアップ言語のHTMLについてまとめました。HTMLは、Web開発をするにあたって欠かせない知識となっています。ぜひ最後までお読みください！

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

便利な【AWS】について

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

【初心者用】SQL サブクエリについてまとめてみた

SQLのサブクエリ(副問い合わせ)について今回色々操作をしていく。 サブクエリを活用できることで、SQLの活用の幅が広がり、複雑なクエリを記述することができるため、少しずつ慣れていこう。 参考サイト https://style.potepan.com/articles/17593.html SQLの幅問い合わせ(サブクエリ)とは? 概要・種類・使い方を解説 https://hironimo.com/prog/sql/subquery/ SQLServer 副問い合わせ

javascript 基本文法5

javascript 基本文法5