マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い（アップデートされていない） 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
製造・コーディング(PG/バックエンド)
インフラエンジニアのキャリアアップに必要な資格とは？難易度別にご紹介！
インフラエンジニアとして活躍される方々の中には、社内の保守・運用案件に配属され、やりがいを感じながらも、日々ルーティンワークに追われて成長を実感できず、将来に不安を抱く方もいらっしゃるかもしれません。そこで、本記事では、そのような方に向けて、インフラエンジニアのキャリアアップに必要な資格についてご紹介します。
【初心者用】ifconfigの出力結果の見方
Linuxシステムでネットワーク設定や情報を確認するための基本的なコマンドの1つがifconfigです。この記事では、初心者向けにifconfigコマンドの使用方法、オプション、出力結果の解釈について詳しく説明します。また、具体的な使用シーンや例、関連するコマンドや技術についても紹介します。
その他(インフラ)
【初心者用】webpackやモジュールについて
Reactの開発の勉強をしていく中でwebpackという言葉が出てくることが多く、結構必要な知識なのかなと思い今回改めてまとめていきたいと思います。また、Webpackに関連するモジュールなどの概要についてもまとめて理解したいと思います。
その他(PG/フロントエンド)
【初心者用】Angularについて
いままでReactのみ調べて開発に使用していたのですが、改めて他のフレームワークについて知りたいと思いまとめたいと思いました。後ほど改めて確認する際に、初心者でも理解できるようにまとめれるようにします。
その他(PG/フロントエンド)
【初心者用】Javaについて
Javaに関しては学生時代に触っていましたが、その後社会人になってから触ることがありませんでした。今後触る可能性が少し出てきたので、復習がてらにJavaを再度学びなおしたいと思います。
その他(PG/フロントエンド)
Flutterを使ってみよう その９（レイアウト方法③）
前回の続きで複数の子ウィジェットをレイアウトする場合の説明とそれらを使った例などに触れていきたい思います。以前までに触れてきた下記のウィジェットも複数の子ウィジェットをレイアウトするウィジェットです。 ・Row ：水平整列時に使うウィジェット ・Column ：垂直整列時に使うウィジェット ・ListView ：リスト表示時に使うウィジェット ・GridView ：グリッド表示時に使うウィジェット以降は、その他でも有用なレイアウトウィジェットについて触れておきたいと思います。
製造・コーディング(PG/フロントエンド)
【Java】ビルドツールについて学ぼう
Javaで開発を行う際、ビルドツールを利用された経験はありますか。Javaのビルドツールにはいろいろと種類があります。私はMavenとGradleしか知りませんでした。他に存在するビルドツールの種類についてや、メリット・デメリットについて記事作成を通して学んでいこうと考えてます。
【初心者用】CakePHPを学んでいこう①（基礎知識）
そもそも、PHPとは？ Cake「PHP」とあるように、そもそもPHPとは何かをまずは確認していきましょう。 PHPは、1995年に登場したWebページやWebアプリケーションを作成する際に使用するプログラム言語です。 静的なWebページを表示するHTMLとは違い、ユーザがアクセスしたタイミングによってページ内容が変化する、動的なWebページを開発することができます。 PHPを使用して作成された有名なWebサービスに、WikipediaやFacebook、ぐるなびなどがあります。
製造・コーディング(PG/バックエンド)
関連タグ
カテゴリ別人気記事
もっと見るテレワーク関連人気記事
2023年10月02日
製造・コーディング(PG/フロントエンド)2023年07月18日
アーキテクト・技術選定(PG/バックエンド)2023年10月26日
テスト(運用・保守・サポート)2023年11月17日
2023年01月09日
詳細設計(内部設計)(インフラ)
週間人気記事
もっと見る【これからJP1に触れる人向け】JP1とは
開発プロジェクトに携わる際にJP1というツールに触れたことはあるだろうか。JP1は開発工程、特にテスト作業においては非常に利便性の高いツールである。この記事ではまだJP1に触れたことがない人向けにJP1の概要やJP1を合う買う際に知っておくべき用語を取り上げる。
テスト(運用・保守・サポート)
ActiveReports学習1
頂いた案件でGrapecityのActiveReportsの開発経験という条件があったため、自分の復習と併せて学習していきたいと思います。
製造・コーディング(インフラ)
ITパスポート試験過去問例
ITパスポート試験は、数種類ある情報処理技術者試験の中で、もっとも初級の入口にあたる試験です。ちなみにお題目は「ITに携わる人職業人として誰もが共通に備えておくべき基礎的な知識をはかる」というものです。パソコンが広く活用されるようになった現代では、是非ともおさえておきたい基礎知識だといえます。といっても、相変わらずITといえば慣れない人にはチンプンカンプンな横文字専門用語が目白押し。そのためにも試験では、「まず解説書を一冊完読して、用語や計算になれること」が欠かせません。本記事では、初心者向けにITパスポートの特徴や過去問に触れていきたいと思います。
【初心者向け】Packet Tracerでネットワークを学ぶ（CLI操作の基本編①）
ルータ初期設定編ではPacket Tracerを使ってルータを直接操作し色々な設定を試してみたいと思います。 まずCisco製品のルータにはPCと同様にOSがインストールされています。 それが「Cisco IOS(Internetwork Operating System)」です。 スイッチでもこのOSを利用しています。 Cisco IOSはWindowsのようなグラフィカルなインターフェースではなくコマンド入力のみで様々な操作を行うインターフェースになります。 コマンドで操作するインターフェースのことを「CLI(Command Line Interface）」と言います。
詳細設計(内部設計)(インフラ)
Springを使ったDBデータ検索画面の作成
今回はJavaから画面へ値を渡すプログラムではなく、 画面からJavaへ値を渡して、DBからデータを取得し結果を画面へ表示する 実装方法を紹介していきたいと思います。
製造・コーディング(PG/バックエンド)
Javaを使ったオセロゲームの作成
今回はJavaでオセロゲームを作成したいと思います。 とりあえず何かゲームを作りたくてお手軽にできそうだったので オセロをコンソール画面を使って作っていきたいと思います。 環境 Eclipse(Version: 2022-09 (4.25.0)) Java17
製造・コーディング(PG/バックエンド)
【初心者向け】Packet Tracerでネットワークを学ぶ（インストール編）
ネットワークエンジニアとしてCisco社のルータやスイッチの運用業務を遂行するには、 コマンドの知識やどのように機器が通信させているかよく理解しておく必要があります。 またCCNAといったネットワークのベンダー資格でも実際にコマンドを記述するシミュレーション問題が出題されることもあるので、自身のネットワークスキル向上には日頃からコマンド操作に慣れておく必要があります。 知識を定着や操作の慣れには座学だけでなく実際に機器に触れコマンドを入力し結果を確認することが一番なのですが、ルータやスイッチ等のネットワーク機器はいずれも高額であり、中古でもそれなりの値段となるので初心者が自宅に環境を作成することは簡単ではありません。 そこでCisco社のルータやスイッチに簡単に機器の設定、環境の構築、コマンドの投入練習といったことができるアプリケーションが「Packet Tracer」となります。
詳細設計(内部設計)(インフラ)