マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い(アップデートされていない) 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
製造・コーディング(PG/バックエンド)
イチから学ぶデータベース・SQL(10)
イチから学ぶデータベース・SQL(9)では、サブクエリについて学習していきました。 今回も、これまでと同様paizaラーニングを参考に、オンラインRPGを題材としてSQLについて学習していきます。
製造・コーディング(インフラ)
【iOS】初めてのSwiftUI 【Part2】
【iOS】初めてのSwiftUI 【Part1】が長くなりそうだったので、Part2としてこちらに記録します。それではSwiftUIで新規プロジェクトを作成済みの状態から始めていきます。環境・MacOS Ventura 13.0・Xcode 14.2・Swift version 5.7.2
製造・コーディング(PG/フロントエンド)
SwiftUIの基礎を学ぶ【iOS】
SwiftUIの基礎を学習中のため、UIパーツの加工であったり、UIKitとの連携であったり忘れてしまいそうなことを書き残しておきます。
製造・コーディング(PG/フロントエンド)
キャリアアップへの最短ルート!エンジニアにおすすめのJava資格とその取得方法
Javaは、世界中で最も広く使われるプログラミング言語の1つであり、多くの企業や開発者にとって重要なスキルとなっています。Javaを使ったアプリケーション開発やWeb開発に携わるエンジニアにとって、Javaの資格取得は、より高い技術力と信頼性を証明する重要な手段の一つです。この記事では、Java資格の種類や難易度、必要学習時間、おすすめの資格について解説します。
学習・スキル
テスト自動化ツールとは?メリットデメリットやオススメツールもご紹介!
皆さんはテスト自動化ツールについてご存じでしょうか。開発プロセスにおいて必要不可欠な工程としてテスト工程がありますが、そのテストを自動化して膨大な工数を削減することができるツールとなっております。また人がテストをしていてはどうしてもミスが生じてしまいますが、テスト自動化ツールの場合は自動で行ってくれるので使い方さえ間違えなければミスが発生することはありません。特に大規模なプロジェクトになるほど効果を発揮してくれるテスト自動化ツールについて今回はご紹介いたします。
学習・スキル
需要はある?サーバーエンジニアの将来性と活躍する方法について【初心者向け】
https://pixabay.com/ja/photos/%E4%BA%8B%E6%A5%AD-%E6%8A%80%E8%A1%93-%E5%B8%82-%E3%83%A9%E3%82%A4%E3%83%B3-%E9%9B%BB%E8%A9%B1-5475661/
キャリア
【Python】基本のまとめ | 初心者向け
今回は、プログラミング言語のPythonについて簡単にまとめました。初心者向けの、基本的な内容になっています。ぜひ最後までお読みください!
製造・コーディング(PG/バックエンド)
【初心者用】CCNA学習#6
今回は、いままで学習をしていた進数について、まとめていきたいと思います。いままでの、内容でも軽く触れていましたが、コンピュータの世界の文字は0と1のみでできています。これを2進数といいます。
製造・コーディング(PG/フロントエンド)
サーブレットJSPを学ぼう!#9
前回は簡単なWebアプリケーションを作れるようになりました。しかし、それだけでショッピングサイトのような複雑なWebアプリケーションを作るのは難しく、開発の効率もよくありません。今回は、Webアプリケーションを本格的に作成するための知識を学びます。これまでの学習内容を使ってWebアプリケーションの開発の練習をしていきます。前回までは、1つのリクエストを1つのサーブレットクラスまたは、JSPファイルで処理をしていましたが本格的なアプリケーションを開発するには、より効果的な方法があります。実際の開発現場でも採用されている、Webアプリケーションの模範的な構造と開発手法を学びたいと思います!
製造・コーディング(PG/フロントエンド)
関連タグ
カテゴリ別人気記事
もっと見るテレワーク関連人気記事
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/フロントエンド)
【これからJP1に触れる人向け】JP1とは
開発プロジェクトに携わる際にJP1というツールに触れたことはあるだろうか。JP1は開発工程、特にテスト作業においては非常に利便性の高いツールである。この記事ではまだJP1に触れたことがない人向けにJP1の概要やJP1を合う買う際に知っておくべき用語を取り上げる。
テスト(運用・保守・サポート)
【初心者向け】不具合報告書の書き方
テストエンジニアは業務内で不具合を見つけた際に不具合報告書を起票することになります。不具合報告書とは、発生した不具合の原因と対策について記載した文書です。社内の関係者への共有はもちろん、取引先に提出することもあるため、正確かつわかりやすく記載する必要があります。
初心者
【初心者向け】Packet Tracerでネットワークを学ぶ(CLI操作の基本編①)
ルータ初期設定編ではPacket Tracerを使ってルータを直接操作し色々な設定を試してみたいと思います。 まずCisco製品のルータにはPCと同様にOSがインストールされています。 それが「Cisco IOS(Internetwork Operating System)」です。 スイッチでもこのOSを利用しています。 Cisco IOSはWindowsのようなグラフィカルなインターフェースではなくコマンド入力のみで様々な操作を行うインターフェースになります。 コマンドで操作するインターフェースのことを「CLI(Command Line Interface)」と言います。
詳細設計(内部設計)(インフラ)
【初心者】MySQLの開発環境をつくろう(Windows)
世界中で利用されているデータベースに、MySQLというものがあります。MySQLは利用者も多く重要なデータベースですが、「MySQLって何?」という人もいると思います。本記事では初心者に向けて、MySQLの特徴・インストール方法を説明します。
初心者
【初心者向け】Packet Tracerでネットワークを学ぶ(インストール編)
ネットワークエンジニアとしてCisco社のルータやスイッチの運用業務を遂行するには、 コマンドの知識やどのように機器が通信させているかよく理解しておく必要があります。 またCCNAといったネットワークのベンダー資格でも実際にコマンドを記述するシミュレーション問題が出題されることもあるので、自身のネットワークスキル向上には日頃からコマンド操作に慣れておく必要があります。 知識を定着や操作の慣れには座学だけでなく実際に機器に触れコマンドを入力し結果を確認することが一番なのですが、ルータやスイッチ等のネットワーク機器はいずれも高額であり、中古でもそれなりの値段となるので初心者が自宅に環境を作成することは簡単ではありません。 そこでCisco社のルータやスイッチに簡単に機器の設定、環境の構築、コマンドの投入練習といったことができるアプリケーションが「Packet Tracer」となります。
詳細設計(内部設計)(インフラ)
【初心者用】Linuxファイルシステムとは何か
【図解】初心者向けファイルシステムの基礎知識〜仕組み, OSとの関係, アクセス権との連携〜Linuxファイルシステムとは、コンピュータ上でデータを格納し、組織化するための仕組みです。ファイルやディレクトリ(フォルダ)などのデータを管理し、アクセスするための基盤となります。異なる種類のファイルシステムが存在し、それぞれ異なる特徴を持っています。
その他(インフラ)
