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

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

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

【初心者用】はじめてのC言語1

C言語を勉強して感じたことをまとめていきたいと思います。専門的な用語などは別途わかりやすいように説明致します。

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

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

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

Flutterを使ってみよう その１（環境構築）

Flutterとは、Googleが開発してマルチプラットフォームの開発フレームワークで複数のアプリを同じソースで開発できる仕組みです。とりあえず、使ってみようということで今回の目的は、環境構築から進めます。環境・MacOS Ventura 13.6.3・Xcode 15.1※今回はiOS環境開発への環境構築のみ実行

開発環境関連(PG/フロントエンド)

HAクラスタリング

CLUSTERPRO1.HAクラスタリングの不可欠性高可用性（High Availability）クラスタリングは、現代のビジネス環境においてシステムの連続性が不可欠です。この技術は、冗長性を確保してシステムの可用性を向上させる手法であり、企業はシステムのダウンタイムを最小限に抑えることで、信頼性の高いサービス提供を実現しています。2.ClusterProの堅牢な歴史ClusterProは、NECが提供する高可用性クラスタリングソリューションで、その信頼性と機能性において業界をリードしてきました。企業は長い歴史を有するClusterProを利用することで、システムの安定性を確保し、ビジネスの運用上の課題に対処しています。3.SecureCube Access CheckのセキュリティフォーカスSecureCube Access Checkは、セキュリティを最優先に考え、企業の情報資産を確実に保護するために開発されました。アクセス管理においてセキュリティの確保は不可欠であり、SecureCube Access Checkはその要請に応えつつ、使いやすさも兼ね備えています。4.SecureCube Access Check × ClusterProの強力な統合SecureCube Access CheckをClusterProでクラスタリングすることで、これら二つの優れた技術が強力に融合します。企業は、高可用性を提供するClusterProとセキュリティ機能を有するSecureCube Access Checkの組み合わせにより、安定性と機密情報の確実な保護を実現できます。

その他(インフラ)

【パート１】ChatGPTをデスクトップ上から使えるようにデスクトップアプリ化してみた｜Node.js & Electron

最近、ChatGPTという物がとても注目されています。私自身も、実際に使用してみてその性能に驚きました。簡単な質問はもちろん、前提条件を指定した文章の作成や、プログラミングのコード作成までできてしまいます。今回はその便利なChatPGTをデスクトップアプリ化し、どこからでも質問を行えるようにしていきたいと思います。

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

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

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

データ分析に使用されるR言語の基礎構文をまとめてみた

R言語は、統計解析やデータ分析に特化したプログラミング言語であり、初心者でも比較的簡単に学ぶことができます。今回はR言語の初心者向けにR言語の基礎を紹介しようと思います。

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

Pythonの基本構文

Python(パイソン)とは、1991年にオランダ人のGuido van Rossum（グイド・ヴァン・ロッサム）氏が開発したプログラミング言語です。アプリケーションの開発、人工知能、データ解析など様々な用途に使用でき、少ないコード量で簡潔に書けるため、読み間違えや書き間違い起こりづらいのが特徴です。文法がシンプルでわかりやすく初心者でも取り掛かり易い言語です。

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

【Swift】TableViewのカスタムセルの作り方と使い方【TableViewCell】

何かと使用頻度の多いTableView。今回はそのTableViewのに使われるセルのカスタム方法について解説します。カスタムセルの作り方の説明、扱い方の説明などできるだけ細かく説明していますので、iOSのアプリ開発が初心者の方にも参考になると思います。環境・MacOS Ventura 13.0・Xcode 14.2・Swift version 5.7.2

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

Flutterを使ってみよう その１１（入力操作②）

今回は、ポップアップ等の別画面での入力操作用のウィジェットの実装方法の知識を深めていきたいと思います。環境　・MacOS Ventura 13.6.3　・Xcode 15.1　・VSCode 1.85.1　・Flutter 3.16.5　・Dart 3.2.3

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

【JSTQB(FL)対策】第1章テストの基礎 1.4テストプロセス1.5テストの心理学

こちらの記事ではJSTQBのシラバスのうち、第1章テストの基礎分野における以下の分野の学習内容及び学習してみて私が思ったことについて記載します。・1.4テストプロセス・1.5テストの心理学

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