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

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

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

STP(Spanning Tree Protocol)はブロードキャストストームを防止するためにポートの通信を行わない状態に遷移させるプロトコルです。 ブロードキャストストームとはスイッチがループになったネットワークでずっとブロードキャスト通信であるARP要求を送り続ける状態のことをいいます。

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

jQueryを使用してみよう

jQueryとはJavaScriptライブラリです。jQueryを使うことで、インタラクティブな仕掛けもシンプルに実装出来ます。

開発環境関連(PG/フロントエンド)

【Swift】Cloud FireStoreを使ったサンプルアプリを作ってみる【Firebase】【iOS】

Firebaseでチャットのようなリアルタイム更新が必要なアプリを作るには、Realtime Databaseを使う必要が有ると思っていました。公式のドキュメントを読んでいると、Cloud FirestoreとRealtime Databaseの比較についての記事がありまして、どちらもリアルタイム更新が実現できると記載がありました。簡単に調べた限りだと料金プラン的にもFirestoreを使ったほうがコストを抑えることができるようです。今回はこのCloud Firestoreを使って、リアルタイム更新、データの追加、取得、削除を行うサンプルを作ってみます。環境・MacOS Ventura 13.0・Xcode 14.2・Swift version 5.7.2

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

【iOS】初めてのSwiftUI 【Part1】

環境・MacOS Ventura 13.0・Xcode 14.2・Swift version 5.7.2

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

CCNA学習＃５未経験の方向け

復習・トランスポート層（レイヤ4）とは、通信における信頼性に関するプロトコル群です。・通信の方式、通信状態の確認方法、以上発生時の対処など通信が期待通り行われるためのプロトコルを定義しています。前回までは、ホスト同士の通信IPアドレスについて、まとめていました。IPアドレスが郵便番号、ポート番号が住所でかみ砕いて理解しましょう。

その他(インフラ)

【C# WPF】WPFを理解したいC#初心者の話【MVVMパターン編その3】

C# WPFについて学んでいく過程を備忘録として残して置きたいと思います。

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

【C# WPF】WPFを理解したいC#初心者の話【MVVMパターン編その5】

C# WPFについて学んでいく過程を備忘録として残して置きたいと思います。

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

【PowerShell】基礎的な用語から

PowerShellはコマンドプロンプトの強化版ということで、業務のさまざまな場面で活用できます。「get-command」を実行し、コマンドレット一覧を表示させ、そこから活用し業務に生かせるようになりたいです。その前にPowerShellででてくる用語などについて理解しておきたいと思います。

テスト(IT事務全般)

ネットワークの基礎①

コンピュータは、さまざまな進化や発展を遂げてきました。大型汎用コンピュータ、スーパーコンピュータ、ミニコンピュータ、パーソナルコンピュータ、ワークステーション、ラップトップコンピュータ、そして、スマートフォンと、多種多様なコンピュータが誕生してきました。年々、性能は向上しています。・大型汎用コンピュータ汎用機…メインフレームとも呼ばれている大型コンピュータです。また、ホストコンピュータと呼ばれることもあります。※TCP/IPの世界では、IPアドレスが設定されたコンピュータは、ラップトップ型のコンピュータであっても「ホスト」と呼ばれるので、混同しないように注意しましょう。・スーパーコンピュータ…計算能力が非常に高いコンピュータです。複雑な科学技術計算などに用いられます。・ミニコンピュータ…大型汎用コンピュータよりも「ミニ」サイズのコンピュータのことです。実際の大きさはタンスほどの大きさがあります。

その他(インフラ)

【初心者用】ifconfigの出力結果の見方

Linuxシステムでネットワーク設定や情報を確認するための基本的なコマンドの1つがifconfigです。この記事では、初心者向けにifconfigコマンドの使用方法、オプション、出力結果の解釈について詳しく説明します。また、具体的な使用シーンや例、関連するコマンドや技術についても紹介します。

その他(インフラ)

Flutterを使ってみよう その８（レイアウト方法②）

前回の続きで他のレイアウトについて、触れていきたいと思います。環境　・MacOS Ventura 13.6.3　・Xcode 15.1　・VSCode 1.85.1　・Flutter 3.16.5　・Dart 3.2.3

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