マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い（アップデートされていない） 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
【初心者】kintoneとは
kintoneは、独自のアプリを作成することで業務効率を改善するクラウドサービスです。実際に、20000社以上の企業がkintoneを導入し、業務効率改善や売上向上を実現しています。kintoneはノーコード開発が可能で、プログラミングの知識やスキルがなくても、アプリケーションやWebサービスの開発が可能です。開発期間が短いため、ソースコードを書く必要がないです。大幅なスピードアップが可能です。今回はkintoneとはどのようなツールなのか、どのようなサービス内容なのかを紹介します。
【初心者向け】Packet Tracerでネットワークを学ぶ（STP）
STP(Spanning Tree Protocol)はブロードキャストストームを防止するためにポートの通信を行わない状態に遷移させるプロトコルです。 ブロードキャストストームとはスイッチがループになったネットワークでずっとブロードキャスト通信であるARP要求を送り続ける状態のことをいいます。
詳細設計(内部設計)(インフラ)
CCNA学習＃５未経験の方向け
復習・トランスポート層（レイヤ4）とは、通信における信頼性に関するプロトコル群です。・通信の方式、通信状態の確認方法、以上発生時の対処など通信が期待通り行われるためのプロトコルを定義しています。前回までは、ホスト同士の通信IPアドレスについて、まとめていました。IPアドレスが郵便番号、ポート番号が住所でかみ砕いて理解しましょう。
その他(インフラ)
Ndde.jsの構文まとめ｜中級者向け
Node.jsは、JavaScriptの実行環境として、Webアプリケーションの開発に欠かせない存在となっています。今回は、Node.jsの構文についてまとめてみました。Node.jsの基礎を既に知っている人向けの内容になっています。
ゲームプログラマーの需要から見るその将来性への期待！
どの年代においても娯楽の上位には必ず「ゲーム」が君臨し続けています。それを作っているのがゲームプログラマーです。ゲームに需要があり続ける限り、ゲームプログラマーは必要とされ続けるでしょう。常に娯楽の上位にいるからこそ、安定した将来性もあるといえるのではないでしょうか。今回は、ゲーム産業を支える「ゲームプログラマー」の需要と将来性について、触れるとともに「ゲームプログラマーとしてキャリア形成をしたい！」と思っている方へ少しでもためになる情報をお届けします。
【PowerShell】基礎的な用語から
PowerShellはコマンドプロンプトの強化版ということで、業務のさまざまな場面で活用できます。「get-command」を実行し、コマンドレット一覧を表示させ、そこから活用し業務に生かせるようになりたいです。その前にPowerShellででてくる用語などについて理解しておきたいと思います。
テスト(IT事務全般)
ネットワークの基礎①
コンピュータは、さまざまな進化や発展を遂げてきました。大型汎用コンピュータ、スーパーコンピュータ、ミニコンピュータ、パーソナルコンピュータ、ワークステーション、ラップトップコンピュータ、そして、スマートフォンと、多種多様なコンピュータが誕生してきました。年々、性能は向上しています。・大型汎用コンピュータ汎用機…メインフレームとも呼ばれている大型コンピュータです。また、ホストコンピュータと呼ばれることもあります。※TCP/IPの世界では、IPアドレスが設定されたコンピュータは、ラップトップ型のコンピュータであっても「ホスト」と呼ばれるので、混同しないように注意しましょう。・スーパーコンピュータ…計算能力が非常に高いコンピュータです。複雑な科学技術計算などに用いられます。・ミニコンピュータ…大型汎用コンピュータよりも「ミニ」サイズのコンピュータのことです。実際の大きさはタンスほどの大きさがあります。
その他(インフラ)
関連タグ
カテゴリ別人気記事
もっと見るテレワーク関連人気記事
-
2023年10月02日
製造・コーディング(PG/フロントエンド) -
2023年07月18日
-
2023年10月26日
テスト(運用・保守・サポート) -
2023年01月09日
詳細設計(内部設計)(インフラ) -
2023年11月17日
週間人気記事
もっと見る【初心者向け】Packet Tracerでネットワークを学ぶ（CLI操作の基本編①）
ルータ初期設定編ではPacket Tracerを使ってルータを直接操作し色々な設定を試してみたいと思います。 まずCisco製品のルータにはPCと同様にOSがインストールされています。 それが「Cisco IOS(Internetwork Operating System)」です。 スイッチでもこのOSを利用しています。 Cisco IOSはWindowsのようなグラフィカルなインターフェースではなくコマンド入力のみで様々な操作を行うインターフェースになります。 コマンドで操作するインターフェースのことを「CLI(Command Line Interface）」と言います。
詳細設計(内部設計)(インフラ)
【IT転職】Androidエンジニアって何？必要なスキルや資格を解説します！！
世界中で使用者が増え続けるスマホOSの一つであるAndroidですが、その成長の背景にはAndroid端末を専門にアプリケーション開発をするAndroidエンジニアの存在があります。将来性が高いと噂されるAndroidエンジニアですが、その実態はどうなのでしょうか。今回は、Androidエンジニアとは何か、将来性はあるのか、そしてAndroidエンジニアになるために必要なスキルや資格を紹介します。ぜひ最後までご覧くださいね。この記事を読むのにおすすめな人この記事は以下のような人におすすめです。・Androidエンジニアになりたいと考えている人・Androidエンジニアになるにあたって必要なスキルや資格を知りたい人・インフラエンジニアなどの他職種からAndroidエンジニアへに転職を考えている人
【初心者用】SWCについて
Reactの開発関連の勉強などをしていく中で、SWCなどを適用するかどうかなどの文言が出てきました。導入すると開発でメリットがあるようなのですが、どんなことができるのか理解していないため勉強のためにまとめます。
その他(PG/フロントエンド)
テスト計画書とは？作成する理由や記載必須の内容について教えます！
開発プロセスにおけるテストとは、そのソフトウェアの品質を決める重要なファクターとなっております。テストを正しく実施することはそのまま品質を上げることになります。テストとはいっても、ただやるだけではなく、事前に計画を立てて無理のないスケジューリングを行った上で実施する必要があります。そこで今回はテストにおけるテスト計画書の作成方法やテスト設計所との違い、なぜ必要であるかをご説明いたします。
【初心者向け】CCNA基礎 11章
こちらでは、CCNAの資格取得へ向けた情報を記載いたします。
＃09 社員インタビュー【育児もキャリアも、どちらも大切にしたい。フロントエンドエンジニアとして働く、私のリアルな毎日】
こんにちは！今回は、ラーニンギフトで活躍中のフロントエンドエンジニアにインタビュー🎤育児と仕事を両立しながら、自分らしいキャリアを歩んでいる社員のリアルな声をお届けします！「エンジニアとして成長したい」「でも、子どもとの時間も諦めたくない」そんな想いを持っている方に、ぜひ読んでほしい内容です😊
#11キャリアサポーターって何してるの？【“案件に入って終わり”じゃない。キャリサポのリアルに密着】
こんにちは！採用担当です😊今回は、当社でエンジニアのキャリア支援を行っている「キャリアサポーター（通称：キャリサポ）」にインタビュー！SES業界では、「案件参画後は放置だった…」 「相談できる人がいなかった…」そんな声を聞くことも少なくありません。では実際に、当社のキャリサポはどんなことをしているのでしょうか？今回は、・面談で何を見ているのか・どんな人が伸びやすいのか・印象に残っている支援事例 など、“キャリア支援のリアル”について聞いてみました✨
【JSTQB(FL)対策】第5章テストマネジメント<5.1テスト組織～5.2テスト計画作業と見積り
こちらの記事ではJSTQBのシラバスのうち、第5章テストマネジメント分野<5.1テスト組織～5.2テスト計画作業と見積り>における以下の分野の学習内容及び学習してみて私が思ったことについて記載します。
テスト(運用・保守・サポート)
Salesforceエンジニアになるためには？必要な基本知識とスキル、ロードマップを解説
Salesforceエンジニアとは、Salesforceというクラウド型のCRM（顧客管理）システムを開発・運用するエンジニアのことです。主に、Salesforceの機能やカスタマイズを行い、企業のビジネスニーズに応えるシステムを構築する仕事です。この記事では、高い需要と高い報酬を得られる職種として注目されている、Salesforceエンジニアの仕事内容や将来性について解説します。