マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い（アップデートされていない） 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
製造・コーディング(PG/バックエンド)
【DOM】基本のまとめ | 初心者向け
HTMLの標準オブジェクトモデルおよび、プログラミングインターフェイスであるDOMについてまとめました。DOMは、Webアプリケーション制作にかかせない知識となっています。ぜひ最後までお読みください！
製造・コーディング(PG/フロントエンド)
【PHP】基本のまとめ | 初心者向け
プログラミング言語のPHPについて、簡単にまとめてみました。初心者向けの、基本的な内容になっています。ぜひ最後までお読みください！
製造・コーディング(PG/バックエンド)
【Python】基本のまとめ | 初心者向け
今回は、プログラミング言語のPythonについて簡単にまとめました。初心者向けの、基本的な内容になっています。ぜひ最後までお読みください！
製造・コーディング(PG/バックエンド)
自宅のWindowsでRuby on Rails ～ 非同期処理
今回は、Railsでの非同期処理について学習していきます。自宅のWindowsでRuby on Rails ～データベース操作２で途中まで実装していた、仕入帳アプリの続きを実装しながら学習します。
製造・コーディング(PG/バックエンド)
【初心者用】CCNA学習＃6
今回は、いままで学習をしていた進数について、まとめていきたいと思います。いままでの、内容でも軽く触れていましたが、コンピュータの世界の文字は０と１のみでできています。これを２進数といいます。
その他(インフラ)
ITパスポート試験過去問例
ITパスポート試験は、数種類ある情報処理技術者試験の中で、もっとも初級の入口にあたる試験です。ちなみにお題目は「ITに携わる人職業人として誰もが共通に備えておくべき基礎的な知識をはかる」というものです。パソコンが広く活用されるようになった現代では、是非ともおさえておきたい基礎知識だといえます。といっても、相変わらずITといえば慣れない人にはチンプンカンプンな横文字専門用語が目白押し。そのためにも試験では、「まず解説書を一冊完読して、用語や計算になれること」が欠かせません。本記事では、初心者向けにITパスポートの特徴や過去問に触れていきたいと思います。
初心者
ITパスポート試験過去問例2
ITパスポート試験の合格は、情報技術の基礎を理解し、一定のスキルを持つことを証明する素晴らしい手段です。ITパスポート試験に合格するために勉強していきたいと思います。本記事では、ITパスポート試験の過去問をピックアップしていきます。
初心者
ITパスポート試験過去問3
ITパスポート試験は、国家資格である情報処理技術者試験の12区分の1つであり、初級レベル（レベル1）に位置づけられています。本記事では、ITパスポート試験の過去問の解説をしていきます。
初心者
テスト自動化
テスト自動化とは、人の手によって行われるソフトウェアテストの全体あるいは一部を自動化することを意味します。そもそもソフトウェアテストは、不具合を見つけることが目的です。そのため、テストを繰り返し行うことも増えています。テスト自動化によって、テストにかかる人的負担を減らし、将来的なコストの削減が期待できます。テストといっても、その中にはさまざまなプロセスが含まれます。ソフトウェアテスト技術者資格認定組織である「ISTQB（国際ソフトウェアテスト資格認定委員会）／JSTQB（日本ソフトウェアテスト技術者資格認定組織）」の定義によると、テストプロセスは以下の5つの要素で構成されています。テストプロセス ・テスト計画作業とコントロール ・テストの分析と設計 ・テストの実装と実行 ・終了基準の評価とレポート ・終了作業
テスト(運用・保守・サポート)
関連タグ
カテゴリ別人気記事
もっと見るテレワーク関連人気記事
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を合う買う際に知っておくべき用語を取り上げる。
テスト(運用・保守・サポート)
DBのビューとは？メリットデメリットや使用方法についても紹介！
アプリケーション開発にとってデータベースは必須スキルとなっております。データベースの知識がないと、アプリケーション開発に難航することでしょう。しかしデータベースの知識を身に付けるとなると、かなりの勉強量を要します。というのもデータベースオブジェクトには様々な種類があり、一朝一夕では身に付くものではありません。今回は、データベースのビューについてご説明いたします。ビューそのものは必ず覚えてなくてはならないと言うものではありませんが、よく使われます。まずは本記事でビューの基礎知識を身に付けてください。本記事ではメリットデメリットや具体的な使用方法について紹介しております。
学習・スキル
【初心者向け】Packet Tracerでネットワークを学ぶ（NAT）
NATとはNetwork Address Translationの略称でIPアドレスを変換する技術です。 インターネットに接続する際にプライベートIPアドレスをグローバルIPアドレスに変換します。
詳細設計(内部設計)(インフラ)
【初心者向け】Packet Tracerでネットワークを学ぶ（CLI操作の基本編①）
ルータ初期設定編ではPacket Tracerを使ってルータを直接操作し色々な設定を試してみたいと思います。 まずCisco製品のルータにはPCと同様にOSがインストールされています。 それが「Cisco IOS(Internetwork Operating System)」です。 スイッチでもこのOSを利用しています。 Cisco IOSはWindowsのようなグラフィカルなインターフェースではなくコマンド入力のみで様々な操作を行うインターフェースになります。 コマンドで操作するインターフェースのことを「CLI(Command Line Interface）」と言います。
詳細設計(内部設計)(インフラ)
インデックスとは？メリットデメリットやインデックスの種類も交えてご紹介
インデックスとは、データベースを扱う際には欠かすことのできない概念となります。インデックスの取り扱いによって、データのアクセス速度が大きく変わります。特に大規模なデータを扱う場合には、取り扱いに気をつけなくてはなりません。インデックスを設定した結果、処理速度が遅くなってしまうことやそもそもインデックスを使用するような実行計画が選択されないこともあるのです。インデックスは、DBMSの種類（例えば、OracleやMySQL、Postgreなど）によっても異なります。インデックスの仕様を知らないと、開発者にとって意図しない処理をしてしまう可能性もあります。そこで今回はインデックスについてメリットデメリットや具体的にどのような種類があるのかを説明していきます。
学習・スキル
AUTOSARについて、まとめてみた
AUTOSAR(オートザー)とは、Automotive Open System Architectureの略称で、車載ソフトウェアの共通化を実現するためのプラットフォームの仕様名称でもあります。
開発環境関連(PG/フロントエンド)
【初心者向け】不具合報告書の書き方
テストエンジニアは業務内で不具合を見つけた際に不具合報告書を起票することになります。不具合報告書とは、発生した不具合の原因と対策について記載した文書です。社内の関係者への共有はもちろん、取引先に提出することもあるため、正確かつわかりやすく記載する必要があります。
初心者