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

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

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

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

Webアプリケーションの開発 第2回について書いていきます。

初心者

【初心者用】PHPとは

フロントエンド開発の勉強をしていて基本的にはNode.jsを使用していたのですが、次回はPHPを使用してサーバー側の処理を作成しようと考えているので今回まとめようと思います。また、結構PHPを使用している所が多いようなので、知らないよりも知っている方が何かと便利かなと思います。

その他(PG/フロントエンド)

【初心者用】VB.Netとは

現在特には使用することがないのですが、様々な案件でVB.Netを使用する所が多いので気になっていました。どのようなことに使用するのか理解していないので、どこでどんな風に利用する言語なのかまとめたいと思います。

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

仕事の流れを可視化する業務フローの作り方

システム開発の現場に参画して一番最初に学ぶ内容が、今回紹介する業務フローです。 前回紹介したマニュアルと近しいドキュメントにはなってしまいますが、マニュアルと業務フローは全く別の観点から作り上げるドキュメントです。 マニュアルは、システムの操作方法などを記したドキュメントなのに対して、業務フローは【仕事の内容や手順を図で表したもの】です。 業務を視覚化することで、見落としを行うリスクが軽減し、文章で手順を読むよりもわかりやすく、全体像を掴みやすくするというメリットがあります。 各現場によっては非常に読みづらい業務フローが整備されていますが、適切に書かれたフローであれば業務の流れを直観的に理解しやすく、業務マニュアルや新人研修としても活用できるため、非常に効果的です。 担当者が業務を改善したり、他部署の業務について相互理解を深めたりするツールとしても有効です。 小規模・中規模のシステムにも活用できますが、大規模なシステムにおいては、全体の機能を業務フローで表すことができるので、保守性の向上にもつなげることができます。 障害が発生して調査をおこなう場合などでも、ソースコードのみを調べると時間がかかりますが、業務フローがあれば、機能ごとのきりわけができるので問題を早く特定しやすくなります。 もちろん、システムの機能拡張や業務内容の変更の際も、業務フローがあれば検討資料としても活用されるシーンが多いです。 業務フロー作成の目的をまとめると、 ・業務の視覚化、標準化 ・業務の問題の発見 ・担当者および他部署間の業務の把握、相互理解 ・業務の保守性、拡張性の向上

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

【C# WPF】WPFを理解したいC#初心者の話【アプリ作成編2】

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

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

【初心者向け】Packet Tracerでネットワークを学ぶ（ルーティング②）

Packet Tracerでネットワークを学びます。

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

テスト自動化ツールとは？メリットデメリットやオススメツールもご紹介！

皆さんはテスト自動化ツールについてご存じでしょうか。開発プロセスにおいて必要不可欠な工程としてテスト工程がありますが、そのテストを自動化して膨大な工数を削減することができるツールとなっております。また人がテストをしていてはどうしてもミスが生じてしまいますが、テスト自動化ツールの場合は自動で行ってくれるので使い方さえ間違えなければミスが発生することはありません。特に大規模なプロジェクトになるほど効果を発揮してくれるテスト自動化ツールについて今回はご紹介いたします。

学習・スキル

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

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

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

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

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

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

【まだ現役？】COBOLの現在と将来性

COBOL（Common Business-Oriented Language）は、主にビジネスアプリケーションの開発に使用されるプログラミング言語です。1959年に開発され、それ以来、経済、財務、および行政の分野で幅広く利用されてきました。COBOLは、大規模なデータ処理やトランザクション処理に特化しており、特に企業のバックエンドシステムで使用されることが一般的です。

【初心者用】イベントドリブンモデルについてまとめてみた

仕事で使うことになったASP.NETを勉強していて、「イベントドリブンモデル」という単語が出てきて「何それ？」となったので、メモがてらまとめてみました。 当記事では、 ・イベントドリブンとは何か（ざっくりと） ・細かく説明したらどんなものなのか ・プログラミングの形としてはどうなるのか について説明していきます。 ガリガリと専門用語を噛み砕きながら書いていくので、プログラミング経験者にはやや冗長気味かもしれませんが、タイトル通りプログラミング初心者にも分かりやすい内容になるかと思います。

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