マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い(アップデートされていない) 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
製造・コーディング(PG/バックエンド)
JSTQB対策(テストの基礎)
現在システムは、自動車、Webサイト、ショッピングセンターなど様々な分野で使用されています。しかし、ソフトウェアが正常に動作しないとユーザーに不都合を与え、最悪の場合障害や死亡事故が発生してしまいます。そこでシステムを開発をした後は、テストを実施して故障が発生する可能性を低くします。今回の記事では、JSTQB対策としてテストについての基本について学習します。
【JSTQB(FL)対策】第3章静的テスト
こちらの記事ではJSTQBのシラバスのうち、第3章静的テスト分野における以下の分野の学習内容及び学習してみて私が思ったことについて記載します。
テスト(運用・保守・サポート)
プロジェクト管理ツールの選び方とおすすめのツール5選
近年のビジネス環境では、複雑化するプロジェクトを効率的に管理することが成功のカギとなっています。プロジェクト管理ツールは、この複雑な課題に対応するための強力な武器であり、プロジェクトの透明性を高め、意思決定を迅速化します。しかし、プロジェクト管理ツールには様々な種類や機能があり、どれを選ぶか迷ってしまうことも多いと思います。そこで、この記事では、プロジェクト管理ツールの選び方と、よく使用されるプロジェクト管理ツールの特徴やメリット・デメリットを解説します。
【CSS】基本のまとめ | セレクター編
今回は、Webページの見た目を設定するCSSのセレクターについてまとめました。CSSは、Web開発をするにあたって欠かせない知識となっています。ぜひ最後までお読みください!
製造・コーディング(PG/フロントエンド)
【HTML】さまざまなタグ | Part 2
今回は、HTMLのさまざまなタグについてまとめました。HTMLは、Web開発をするにあたって欠かせない知識となっています。ぜひ最後までお読みください!
製造・コーディング(PG/フロントエンド)
【初心者用】AWS基礎⑦
前回はクラウドプラクティショナーの出題範囲のうちのAWSの主要サービスの識別までを学習してきました。今回はAWSの主要サービスの識別のところについて、さらに学習していきたいと思います。
その他(インフラ)
【選び方ガイド】おすすめのスマホアプリ開発言語とその将来性
スマートフォンアプリの開発に取り組む際、適切なプログラミング言語を選ぶことが重要です。しかし、初めてのプロジェクトや多くの選択肢がある中で、どの言語を選ぶべきか悩むこともあるでしょう。本記事では、スマホアプリ開発における言語選びのポイントを解説します。
基本情報技術者試験は意味ないはウソ?資格取得のメリット・試験概要・難易度を解説!
IT業界に携わるビジネスパーソンや、これからITスキルを身につけたいエンジニア候補生にとって、基本情報技術者試験は最初に挑戦したい国家試験の一つです。しかし、基本情報技術者試験は難易度が高く、合格率も低いというイメージがあります。また、最近では学校や会社で薦められて基本情報技術者試験を取得したが、全く使うシーンがなく意味がないといった声も聞きます。この記事では、なぜ意味がないと言われるのか、その理由や、エンジニアにとってのメリット、基本情報技術者試験の概要や難易度・合格方法を解説します。
単体テストとは
単体テスト(ユニットテストと呼ばれることもあります)は、プログラムを構成する比較的小さな単位(ユニット)が個々の機能を正しく果たしているかどうかを検証するテストです。通常、関数やメソッドが単体テストの単位(ユニット)となります。 プログラムが全体として正しく動作しているかを検証する結合テストは、開発の比較的後の段階でQAチームなどによって行なわれることが多いのとは対照的に、単体テストは、コード作成時などの早い段階で開発者によって実施されることが多いのが特徴です。
関連タグ
カテゴリ別人気記事
もっと見るテレワーク関連人気記事
2023年10月02日
製造・コーディング(PG/フロントエンド)2023年07月18日
アーキテクト・技術選定(PG/バックエンド)2023年10月26日
テスト(運用・保守・サポート)2023年11月17日
2023年01月09日
詳細設計(内部設計)(インフラ)
週間人気記事
もっと見る【これからJP1に触れる人向け】JP1とは
開発プロジェクトに携わる際にJP1というツールに触れたことはあるだろうか。JP1は開発工程、特にテスト作業においては非常に利便性の高いツールである。この記事ではまだJP1に触れたことがない人向けにJP1の概要やJP1を合う買う際に知っておくべき用語を取り上げる。
テスト(運用・保守・サポート)
DBのビューとは?メリットデメリットや使用方法についても紹介!
アプリケーション開発にとってデータベースは必須スキルとなっております。データベースの知識がないと、アプリケーション開発に難航することでしょう。しかしデータベースの知識を身に付けるとなると、かなりの勉強量を要します。というのもデータベースオブジェクトには様々な種類があり、一朝一夕では身に付くものではありません。今回は、データベースのビューについてご説明いたします。ビューそのものは必ず覚えてなくてはならないと言うものではありませんが、よく使われます。まずは本記事でビューの基礎知識を身に付けてください。本記事ではメリットデメリットや具体的な使用方法について紹介しております。
【初心者用】SQL インデックスとビューについてまとめてみた
参考サイト https://style.potepan.com/articles/25208.html SQLのインデックスとは? 作成、確認、削除方法からメリットまで解説! https://medium-company.com/sql-index/ SQL インデックス(INDEX)を作成・削除する http://dbonline.s25.xrea.com/sqlite/index/index3.html UNIQUEインデックス https://www.sejuku.net/blog/52356 SQL入門 PRIMARY KEY(主キー)制約とは? 追加や削除についても解説 https://style.potepan.com/articles/26878.html SQL 主キー(PRIMARY KEY)制約って何? サンプルコードで基本的な使い方を確認しよう! https://smallit.co.jp/blog/a1015/ BLOG SQLのビューについて https://products.sint.co.jp/siob/blog/view ビューとは? 使い方を解説 https://style.potepan.com/articles/25504.html SQLのビューって何? 基本的な使い方を理解しよう https://cs.wingarc.com/manual/drsum/5.5/ja/UUID-3b6e70a4-5a0d-205e-4b2b-fcb2df959cfd.html ALTER VIEW ビューの定義を変更する
製造・コーディング(SE)
GitHubのReadmeをMarkdown記法で書く
Markdown記法は、プレーンテキストに特定の書式を付けることで、簡単にWebページやドキュメントを作成するための記法です。Markdown記法は、文書の見た目を整えるためのHTMLタグを記述する必要がなく、テキストファイルとしても読み書きが容易であるため、多くの人々によって広く使用されています。
プロジェクト推進・管理(PG/バックエンド)
【初心者向け】Packet Tracerでネットワークを学ぶ(CLI操作の基本編①)
ルータ初期設定編ではPacket Tracerを使ってルータを直接操作し色々な設定を試してみたいと思います。 まずCisco製品のルータにはPCと同様にOSがインストールされています。 それが「Cisco IOS(Internetwork Operating System)」です。 スイッチでもこのOSを利用しています。 Cisco IOSはWindowsのようなグラフィカルなインターフェースではなくコマンド入力のみで様々な操作を行うインターフェースになります。 コマンドで操作するインターフェースのことを「CLI(Command Line Interface)」と言います。
詳細設計(内部設計)(インフラ)
【初心者向け】Packet Tracerでネットワークを学ぶ(DHCP)
DHCP(Dynamic Host Configuration Protocol)は自動的にIPアドレスやサブネットマスク等をPCやルータに配布してくれるプロトコルです。
詳細設計(内部設計)(インフラ)
