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

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

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

【初心者】kintoneとは

kintoneは、独自のアプリを作成することで業務効率を改善するクラウドサービスです。実際に、20000社以上の企業がkintoneを導入し、業務効率改善や売上向上を実現しています。kintoneはノーコード開発が可能で、プログラミングの知識やスキルがなくても、アプリケーションやWebサービスの開発が可能です。開発期間が短いため、ソースコードを書く必要がないです。大幅なスピードアップが可能です。今回はkintoneとはどのようなツールなのか、どのようなサービス内容なのかを紹介します。

自宅のWindowsでRuby on Rails ～ ActiveRecordを利用したクエリの実行 ～

クエリとは、データベースに対して情報を取得したり、データを操作するために使用する命令文のことです。クエリは、SQL（Structured Query Language）と呼ばれる特定の言語を使用して記述されます。データベースに対するクエリには、大きく分けて2つの種類があります。1.検索クエリ検索クエリは、データベースから情報を取得するために使用されます。たとえば、あるテーブル内のデータを取得する、条件に一致するデータを取得する、複数のテーブルを結合して情報を取得するなどが挙げられます。2.更新クエリ更新クエリは、データベース内のデータを更新するために使用されます。たとえば、あるテーブル内のデータを更新する、テーブルに新しいデータを挿入する、あるテーブルからデータを削除するなどが挙げられます。Railsにおいては、ActiveRecordがSQLクエリを生成してデータベースに送信するための様々なメソッドを提供しています。これらのメソッドを使用することで、SQLを直接記述することなく、簡単にデータベースを操作することができます。また、ActiveRecordにはSQLインジェクション攻撃から保護するための機能が組み込まれているため、安全なデータベース操作が可能です。

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

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

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

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

jQueryを使用してみよう

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

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

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

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

その他(インフラ)

Ndde.jsの構文まとめ｜中級者向け

Node.jsは、JavaScriptの実行環境として、Webアプリケーションの開発に欠かせない存在となっています。今回は、Node.jsの構文についてまとめてみました。Node.jsの基礎を既に知っている人向けの内容になっています。

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

【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アドレスが設定されたコンピュータは、ラップトップ型のコンピュータであっても「ホスト」と呼ばれるので、混同しないように注意しましょう。・スーパーコンピュータ…計算能力が非常に高いコンピュータです。複雑な科学技術計算などに用いられます。・ミニコンピュータ…大型汎用コンピュータよりも「ミニ」サイズのコンピュータのことです。実際の大きさはタンスほどの大きさがあります。

その他(インフラ)