マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い（アップデートされていない） 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
製造・コーディング(PG/バックエンド)
SwiftUIの基礎を学ぶ【iOS】
SwiftUIの基礎を学習中のため、UIパーツの加工であったり、UIKitとの連携であったり忘れてしまいそうなことを書き残しておきます。
製造・コーディング(PG/フロントエンド)
【初心者目線】Webアプリケーションの開発 第2回
Webアプリケーションの開発 第2回について書いていきます。
【初心者用】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/フロントエンド)
【初心者目線】Webアプリケーションの開発 第8回
【初心者目線】Webアプリケーションの開発 第8回を書きます。
データベースに関する基本知識とSELECT文の基本
TCP/IPの階層モデルのアプリケーション層について、もう少し詳しく学習していきます。また、TCP/IPの通信例を元に、パケットの処理について学んでいきましょう。
製造・コーディング(PG/バックエンド)
【初心者用】ifconfigの出力結果の見方
Linuxシステムでネットワーク設定や情報を確認するための基本的なコマンドの1つがifconfigです。この記事では、初心者向けにifconfigコマンドの使用方法、オプション、出力結果の解釈について詳しく説明します。また、具体的な使用シーンや例、関連するコマンドや技術についても紹介します。
その他(インフラ)
【初心者】MySQLの基本操作
本記事では、MySQLの基本操作について解説します。
関連タグ
カテゴリ別人気記事
もっと見るテレワーク関連人気記事
2023年10月02日
製造・コーディング(PG/フロントエンド)2023年07月18日
アーキテクト・技術選定(PG/バックエンド)2023年10月26日
テスト(運用・保守・サポート)2023年11月17日
2023年01月09日
詳細設計(内部設計)(インフラ)
週間人気記事
もっと見る【これからJP1に触れる人向け】JP1とは
開発プロジェクトに携わる際にJP1というツールに触れたことはあるだろうか。JP1は開発工程、特にテスト作業においては非常に利便性の高いツールである。この記事ではまだJP1に触れたことがない人向けにJP1の概要やJP1を合う買う際に知っておくべき用語を取り上げる。
テスト(運用・保守・サポート)
インデックスとは？メリットデメリットやインデックスの種類も交えてご紹介
インデックスとは、データベースを扱う際には欠かすことのできない概念となります。インデックスの取り扱いによって、データのアクセス速度が大きく変わります。特に大規模なデータを扱う場合には、取り扱いに気をつけなくてはなりません。インデックスを設定した結果、処理速度が遅くなってしまうことやそもそもインデックスを使用するような実行計画が選択されないこともあるのです。インデックスは、DBMSの種類（例えば、OracleやMySQL、Postgreなど）によっても異なります。インデックスの仕様を知らないと、開発者にとって意図しない処理をしてしまう可能性もあります。そこで今回はインデックスについてメリットデメリットや具体的にどのような種類があるのかを説明していきます。
【初心者用】ASP.NETのサーバーコントロールの種類をまとめてみた～その２～
ASP.NET Webフォームで使われるサーバーコントロールについてまとめてみたので、メモがてら記事にします。 それぞれのサーバーコントロールについて、固有のプロパティ等を具体例を交えてざっくり説明していきます。 （ID等の共通するプロパティは別記事で説明しているため、今回は取り上げません） 今回説明するサーバーコントロールは、以下になります。 ・HyperLink コントロール ・CheckBox コントロール ・RadioButton コントロール サンプルコードの開発環境は、 ・Microsoft Visual Studio Community 2022 実行ブラウザは ・GoogleChrome です。
製造・コーディング(PG/バックエンド)
CIとは何か？代表的なCIツールの特徴とメリット・デメリットを解説
CIとは、開発者がコードを頻繁に統合し、自動的にテストやビルドを行うことで、品質や効率を向上させる手法です。 CIを実現するためには、CIツールと呼ばれる専用のソフトウェアが必要です。 CIツールは、コードの変更を検知し、自動的にテストやビルドを実行し、結果を報告する機能を提供します。しかし、CIツールには様々な種類があり、それぞれに特徴やメリット・デメリットがあります。 では、どのようにしてCIツールを選ぶべきでしょうか？ この記事では、代表的なCIツールの概要と選び方について解説します。
【初心者向け】CCNA基礎 15章
こちらでは、CCNAの資格取得へ向けた情報を記載いたします。
GitHubのReadmeをMarkdown記法で書く
Markdown記法は、プレーンテキストに特定の書式を付けることで、簡単にWebページやドキュメントを作成するための記法です。Markdown記法は、文書の見た目を整えるためのHTMLタグを記述する必要がなく、テキストファイルとしても読み書きが容易であるため、多くの人々によって広く使用されています。
プロジェクト推進・管理(PG/バックエンド)
【初心者用】IISについて調べてみた
個人でプログラミングを勉強する際にIISを使用することになったのですが、「IISって具体的には何だっけ？」となったのでまとめてみます。 タイトルにある通り、初心者向けに極力噛み砕いて説明していきます。
製造・コーディング(PG/バックエンド)