マニュアル作成で心がけることとは

皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い（アップデートされていない） 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。

製造・コーディング(PG/バックエンド)

【HTML】さまざまなタグ | Part 3

今回は、HTMLのさまざまなタグについてまとめました。HTMLは、Web開発をするにあたって欠かせない知識となっています。ぜひ最後までお読みください！

製造・コーディング(PG/フロントエンド)

SOAPについて知ろう

皆様、SOAPというワードを耳にしたことはありますか。私はこの記事を作成する前まで恥ずかしながら知りませんでした。今回はSOAPについてどういったものなのか調べてまとめてみました。

【初心者向け】Packet Tracerでネットワークを学ぶ（CLI操作の基本編②）

Packet Tracerでネットワークを学びます

詳細設計(内部設計)(インフラ)

【初心者用】CCNA学習＃6

今回は、いままで学習をしていた進数について、まとめていきたいと思います。いままでの、内容でも軽く触れていましたが、コンピュータの世界の文字は０と１のみでできています。これを２進数といいます。

その他(インフラ)

【初心者向け】Packet Tracerでネットワークを学ぶ（DNS）

DNS(Domain Name System)はドメイン名とIPアドレスを関連付けて管理するサービスです。 ネットワークはIPアドレスを使って通信のやりとりを行いますがIPアドレスでは人がIPアドレスがどこの宛先を指定しているのか分かりません。なのでIPアドレスの代わりとしてドメイン名を使用します。

詳細設計(内部設計)(インフラ)

テスト観点

テスト観点とは、特定の機能に対してどのようなテストを行うことが有効なのかを考えることを指します。テストケースを作成するうえで必要不可欠な要素であり、テストの精度を高めて効率的に作業するために必要とされています。具体的な例をあげると、次の太字個所がテスト観点と呼ばれる部分に該当します。　・住所入力テキストボックス（対象）の入力可能桁数（何）を確認する　・次へボタン（対象）押下の遷移先（何）を確認する　・氏名テキストボックスに入力した内容が氏名欄（対象）に正しく表示（何）されることを確認する特定の機能に対して、どの部分をテストしなければならないのか、その方法は何がふさわしいかを考えるのがテスト観点です。テスト観点を明確にすることで、ソフトウェアテストにおける抜けや漏れを防止することができます。

【初心者向け】レビューについて

テスト設計後に開発者を交えたレビュー会を行う事があります。本記事はレビューについてまとめていきます。

『基礎知識』 Active Directory

Active Directoryについて

イチから学ぶデータベース・SQL（３）

前回まではデータベースの基本やSQLの基礎について説明してきました。 今回からは、SQLを実務で使うための基本的なことについて学びながら説明していきます。

製造・コーディング(インフラ)

Oracle学習1

私はSQLに関しては、SQLServerでの開発をしてきましたが、いただく案件にOracleでの開発という文言をよく見かけます。そのため、自分の学習を兼ねて気になった記事について学習を深めていこうと思いました。

製造・コーディング(インフラ)

【初心者目線】Webアプリケーションの開発 第6回

【初心者目線】Webアプリケーションの開発 第6回を書きます