マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い(アップデートされていない) 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
製造・コーディング(PG/バックエンド)
クラウドサービスについて
クラウドとは、クラウドコンピューティングの略で、ユーザーがサーバーやネットワークなどのインフラやソフトウェアを持たなくてもインターネットと介してサービスを受けることが可能になる仕組みです。自分のコンピューターにソフトウェアをインストールせず、ウェブブラウザなどを使ってシステムを利用します。ソフトウェアを動作させるITリソースやサービスはすべてクラウドベンダーが所有しており、ユーザーはそれらをインターネット経由で利用します。クラウドサービスでは、ソフトウェアの場所やデータ保管先はインターネット上の見えないところにあるので、システムの構成図を表す際に、雲(=クラウド)のマークを使っていたため、「クラウド」と呼ばれるようになったと言われています。
その他(インフラ)
【初心者】基本情報はおすすめ
「基本情報(FE)レベルの知識がある人材がほしい」私が経験半年の駆け出しエンジニアの頃、転職活動の際に言われた言葉です。「学生のうちにITパスポートと基本情報を取っておけば就活で評価される」私が学生(情報理工系、偏差値45ぐらい)の時にとある教授が口酸っぱく言っていました。「ITパスポートも大事だけど取得していてもあまりネタにされない」「未経験のエンジニアは基本情報を取って初めて評価されるみたいな」エンジニアが集う交流会で会った、実務5年以上の先輩が言っていました。この”基本情報”という資格、結構大事だそうです。本記事では、基本情報はおすすめだということを話していきます。
学習・スキル
【PHP】基本のまとめ | 初心者向け
プログラミング言語のPHPについて、簡単にまとめてみました。初心者向けの、基本的な内容になっています。ぜひ最後までお読みください!
製造・コーディング(PG/バックエンド)
LINUXの資格はLPICとLinuCのどちらがおすすめ?試験内容や難易度の違いを解説
LINUXとは、オープンソースで開発されたOSで、サーバーやクラウド、IoTなどの分野で広く利用されており、LINUXのスキルを証明する資格は、IT業界で高い需要があります。LINUXの資格には、主にLPICとLinuCの2つの種類がありますが、それぞれにどのような違いがあるのでしょうか?また、自分に合った資格を選ぶ際には、どのようなポイントに注意すべきなのでしょうか?この記事では、LPICとLinuCの違いとおすすめの選び方について解説します。
学習・スキル
【HTML】さまざまなタグ | Part 3
今回は、HTMLのさまざまなタグについてまとめました。HTMLは、Web開発をするにあたって欠かせない知識となっています。ぜひ最後までお読みください!
製造・コーディング(PG/フロントエンド)
データベースエンジニアに必要な知識やSQL学習、需要と将来性から資格まで徹底解説!
データベースは、情報の集約、管理、活用を可能にしている、私たちの日常生活やビジネスの効率化に欠かせない存在です。データベースを扱うエンジニアをデータベースエンジニアと呼び、データベースを効果的に運用・管理するための、専門的な知識やスキルが求められます。この記事では、データベースエンジニアの仕事内容から、その需要や将来性、そして成功するためのスキルやおすすめの資格について詳しく解説していきます。データベースに関心を持つ方や、データベースエンジニアとしてのキャリアを目指す方に、役立つ情報となれば幸いです。
学習・スキル
【インフラエンジニア】初心者が押さえておきたい言語とスキル
インフラエンジニアはシステムの基盤となるインフラ部分(OS・ネットワーク・サーバ)の設計・構築・運用・保守を行います。そのため、インフラエンジニアにとってプラグラミング言語の学習は必須ではありませんでした。しかし、近年インフラエンジニアを取り巻く環境の変化からプログラミング言語の習得が求められ始めています。そこで本記事では、・プログラミング言語の習得はなぜ必要なのか?・他にどんなスキルが求められているのか?を技術的なトレンドを交えて紹介します。
学習・スキル
フルスタックエンジニアになる方法とは?その働きかたや必要なスキルを解説
フルスタックエンジニアは、ソフトウェア開発の世界において、その柔軟性や効率性の高さから多くの企業が求めているポジションです。また、フルスタックエンジニアを目指すうえで、幅広い技術スキルが身につくため、プロジェクトの全体像が理解できることや、キャリアの選択肢が広がります。では、フルスタックエンジニアになるにはどうしたら良いのでしょうか?この記事では、フルスタックエンジニアの働き方となる方法について解説します。
キャリア
【エンジニアになりたい人必見!】システム開発について
今回はシステム開発の流れや、関連する用語についてまとめました。エンジニアになりたい方に、役立つ内容となっています。ぜひ最後までお読みください!
開発計画(SE)
Deep Security: エンドポイントとサーバーセキュリティの統合プラットフォーム
Deep Securityは、トレンドマイクロが提供する包括的なセキュリティプラットフォームで、物理および仮想環境においてエンドポイントとサーバーのセキュリティを強化します。以下にDeep Securityの主要な機能や特徴について詳細に解説します。
その他(インフラ)
関連タグ
カテゴリ別人気記事
もっと見るテレワーク関連人気記事
2023年10月02日
製造・コーディング(PG/フロントエンド)2023年07月18日
アーキテクト・技術選定(PG/バックエンド)2023年11月17日
学習・スキル2023年10月26日
テスト(運用・保守・サポート)2023年01月09日
詳細設計(内部設計)(インフラ)
週間人気記事
もっと見るGit GUIツールの使い方:初心者向けチュートリアル
Gitとは、分散型バージョン管理システムの1つで、コードやファイルなどの変更履歴を記録し、複数の人で同時に開発を進めるために使われます。Linuxの開発者であるLinus Torvaldsによって開発され、現在は世界中の多くの企業やオープンソースプロジェクトで使用されています。Gitは、ファイルの変更履歴を保存するための「リポジトリ」と呼ばれるデータベースを持ち、このリポジトリに対してコミットと呼ばれる操作で変更履歴を追加していきます。また、ブランチと呼ばれる分岐を作成して、異なるバージョンのコードを管理します。Gitの主な特徴としては、以下のようなものが挙げられます。・ローカルでの高速な動作・分散型であるため、オフラインでも開発ができる・変更履歴を管理しやすく、コードの品質を高めることができる・大規模なプロジェクトでもスケーラブルに対応可能Gitは、コマンドラインツールを使って操作することもできますが、GUIツールを使って操作することもできます。
アーキテクト・技術選定(PG/バックエンド)
【これからJP1に触れる人向け】JP1とは
開発プロジェクトに携わる際にJP1というツールに触れたことはあるだろうか。JP1は開発工程、特にテスト作業においては非常に利便性の高いツールである。この記事ではまだJP1に触れたことがない人向けにJP1の概要やJP1を合う買う際に知っておくべき用語を取り上げる。
テスト(運用・保守・サポート)
インデックスとは?メリットデメリットやインデックスの種類も交えてご紹介
インデックスとは、データベースを扱う際には欠かすことのできない概念となります。インデックスの取り扱いによって、データのアクセス速度が大きく変わります。特に大規模なデータを扱う場合には、取り扱いに気をつけなくてはなりません。インデックスを設定した結果、処理速度が遅くなってしまうことやそもそもインデックスを使用するような実行計画が選択されないこともあるのです。インデックスは、DBMSの種類(例えば、OracleやMySQL、Postgreなど)によっても異なります。インデックスの仕様を知らないと、開発者にとって意図しない処理をしてしまう可能性もあります。そこで今回はインデックスについてメリットデメリットや具体的にどのような種類があるのかを説明していきます。
学習・スキル
【初心者向け】Packet Tracerでネットワークを学ぶ(CLI操作の基本編①)
ルータ初期設定編ではPacket Tracerを使ってルータを直接操作し色々な設定を試してみたいと思います。 まずCisco製品のルータにはPCと同様にOSがインストールされています。 それが「Cisco IOS(Internetwork Operating System)」です。 スイッチでもこのOSを利用しています。 Cisco IOSはWindowsのようなグラフィカルなインターフェースではなくコマンド入力のみで様々な操作を行うインターフェースになります。 コマンドで操作するインターフェースのことを「CLI(Command Line Interface)」と言います。
詳細設計(内部設計)(インフラ)
DBのビューとは?メリットデメリットや使用方法についても紹介!
アプリケーション開発にとってデータベースは必須スキルとなっております。データベースの知識がないと、アプリケーション開発に難航することでしょう。しかしデータベースの知識を身に付けるとなると、かなりの勉強量を要します。というのもデータベースオブジェクトには様々な種類があり、一朝一夕では身に付くものではありません。今回は、データベースのビューについてご説明いたします。ビューそのものは必ず覚えてなくてはならないと言うものではありませんが、よく使われます。まずは本記事でビューの基礎知識を身に付けてください。本記事ではメリットデメリットや具体的な使用方法について紹介しております。
学習・スキル
【初心者用】Active Directoryについて
Active Directory(AD)とはマイクロソフトが提供するWindows Serverに搭載されている機能で、ネットワークにつないでいるクライアント端末やサーバー、プリンター、アプリケーションなどの情報を収集し、一元管理できるディレクトリサービスです。ユーザーアカウントを集中的に管理できるので、ファイルやフォルダの共有データへのアクセス権限、プリンタなどの周辺機器への利用制限などユーザの利用権限を効率的に管理することができます。複雑化するリソース管理のタスクも、Active Directoryを使うことによって管理しやすくなります。
その他(インフラ)
【初心者向け】Packet Tracerでネットワークを学ぶ(DHCP)
DHCP(Dynamic Host Configuration Protocol)は自動的にIPアドレスやサブネットマスク等をPCやルータに配布してくれるプロトコルです。
詳細設計(内部設計)(インフラ)