マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い（アップデートされていない） 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
製造・コーディング(PG/バックエンド)
SwiftUIの基礎を学ぶ【iOS】
SwiftUIの基礎を学習中のため、UIパーツの加工であったり、UIKitとの連携であったり忘れてしまいそうなことを書き残しておきます。
製造・コーディング(PG/フロントエンド)
【初心者用】AWS基礎
Amazon Web Services(AWS)とは、世界中で使われている代表的なクラウドコンピューティングサービスです。Amazon Web Services(AWS)とは、世界中で使われている代表的なクラウドコンピューティングサービスです。・クラウドコンピューティングとはクラウドと呼ばれることもあり、インターネット上で運用されているサーバーなどを利用できるサービスです。ユーザーは自前でサーバーなどのハードウェアやソフトウェアを持たなくても、インターネットを通じて必要な時に必要な分だけ利用できるサービスです。それに対して、自社内にサーバーなどを設置して管理する運用形態は「オンプレミス」といいます。・AWSとはAWSはAmazonのサーバーを借りられるサービスのことです。Amazon社が社内のビジネス課題（システム効率の悪さ、サーバーの準備スピードの遅さ、拡張性の問題など）を解決するために生まれたものがAmazon Web Services(AWS)です。2006年に、このシステムを客向けに開始しました。現在では多くの企業が利用する人気のクラウドコンピューティングサービスとなっています。190以上の国において、数十万人に及ぶ登録アカウントがあります。また、サーバーはEC2、ネットワークはVPCといったサービスで構築することが可能です。
その他(インフラ)
【Java基礎】Java未経験から習得を目指す 環境構築編
どうも、C++が最も得意なプログラマです。仕事の関係でJavaを扱うことになったのですが、Javaに関しては全くの未経験ですので、今回からJavaについて学んでいこうかと思います。
製造・コーディング(PG/フロントエンド)
データベースに関する基本知識とSELECT文の基本
TCP/IPの階層モデルのアプリケーション層について、もう少し詳しく学習していきます。また、TCP/IPの通信例を元に、パケットの処理について学んでいきましょう。
製造・コーディング(PG/バックエンド)
【初心者用】ifconfigの出力結果の見方
Linuxシステムでネットワーク設定や情報を確認するための基本的なコマンドの1つがifconfigです。この記事では、初心者向けにifconfigコマンドの使用方法、オプション、出力結果の解釈について詳しく説明します。また、具体的な使用シーンや例、関連するコマンドや技術についても紹介します。
その他(インフラ)
関連タグ
カテゴリ別人気記事
もっと見るテレワーク関連人気記事
2023年10月02日
製造・コーディング(PG/フロントエンド)2023年07月18日
アーキテクト・技術選定(PG/バックエンド)2023年10月26日
テスト(運用・保守・サポート)2023年11月17日
学習・スキル2023年01月09日
詳細設計(内部設計)(インフラ)
週間人気記事
もっと見る【初心者向け】Packet Tracerでネットワークを学ぶ（NAT）
NATとはNetwork Address Translationの略称でIPアドレスを変換する技術です。 インターネットに接続する際にプライベートIPアドレスをグローバルIPアドレスに変換します。
詳細設計(内部設計)(インフラ)
ECUとはなにか、まとめてみた
ECUとは、車載ECUにおける「ECU」とは、Electronic Control Unit（エレクトロニックコントロールユニット）の略称で、車両のあらゆるシステムを制御する装置の総称です。主にライトやドア、キーレスエントリーシステムなどの車両のボディに関する分野からブレーキ、エンジン、ステアリングなどの制御、オーディオやナビ、GPSなどの情報に関わる分野などもECUが用いられています。現在市販されている自動車には、およそ100個以上ものECUが搭載されており、さらにはハイブリッド車や電気自動車などの環境に対応した最新の自動車にもECUがなくてはならないものとなっています。自動車に関連するECUという用語は、Engine Control Unit（エンジンコントロールユニット）として捉えられることもあります。エンジンコントロールユニットとは、エンジンにおける運転制御を電子的に行うためのマイクロコンピューターのことです。現在ではエンジン制御だけでなく、自動車のあらゆる分野で役割を担っていることから、総称としてElectronic Control Unit（エレクトロニックコントロールユニット）として扱われています。なお、エンジンコントロールユニットの呼び名であり、自動車技術者協会（SAE）および国際標準化機構（ISO）で定義されているものは、ECM（Engine Control Module）と呼ばれます。車載ECUは、自動車に装備されているあらゆる機器やシステムを制御します。この働きによって、エンジン性能の向上や燃費の低減、排出ガスのクリーン化、運転性（ドライバビリティ）の向上などを目指すのが、ECU搭載の目的です。自動車業界の大きな変革期である今、世界中の各自動車メーカーは自社が誇る最新技術を用いて自動車の環境性能や快適性能、安全性能の向上に力を注いでいます。自動運転技術など、これからの自動車においてさまざまな最新機能の司令塔を担うECUは今後の技術発展において必要不可欠なものになっています。
開発環境関連(PG/フロントエンド)
【初心者用】SPAについて
Web開発の勉強をしていく中で、最近のトレンドではSPAという作成方法が採用されていることを知りました。実際にNext.jsなどで作成してみたのですが、詳細をしっかりと理解していないと感じたので、再度SPAでのWebサイト作成をする前にまとめようと思いました。Web開発でSPAは今後も伸びていくので、理解して開発できるよう今回で詳細を学びたいと思います。
その他(PG/フロントエンド)