検索キーワード: 「キー」


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

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

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

【一日目】Java学習

Javaとはプログラミング言語の一種であり、コンピュータに仕事を指示するための言語です。 コンピュータに指示するためにはコンピュータが理解できる機械語で指示をしなくてはならないため、 Javaのようなプログラミング言語を用いる必要がある。

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

【五日目】Java学習

Java学習5日目

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

イチから学ぶデータベース・SQL(3)

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

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

【初心者向け】Packet Tracerでネットワークを学ぶ(DHCP)

DHCP(Dynamic Host Configuration Protocol)は自動的にIPアドレスやサブネットマスク等をPCやルータに配布してくれるプロトコルです。

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

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

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

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

【初心者用】CakePHPを学んでいこう①(基礎知識)

そもそも、PHPとは? Cake「PHP」とあるように、そもそもPHPとは何かをまずは確認していきましょう。 PHPは、1995年に登場したWebページやWebアプリケーションを作成する際に使用するプログラム言語です。 静的なWebページを表示するHTMLとは違い、ユーザがアクセスしたタイミングによってページ内容が変化する、動的なWebページを開発することができます。 PHPを使用して作成された有名なWebサービスに、WikipediaやFacebook、ぐるなびなどがあります。

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

【初心者用】CakePHPを学んでいこう③(モデルの作成とデータ更新)

前回はCakePHPのインストールから簡単な画面表示までをご紹介しました。 今回は前回の続きとなる、簡単なModelの作成と取得したデータベースのデータを更新するところまでご紹介いたします。

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

Oracle学習1

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

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

【初心者用】CakePHPを学んでいこう⑥(メール機能)

前回はCakePHPのバリデーション機能についての説明・実装方法について紹介しました。 今回はローカル環境でメールを送信する方法についてご紹介します。

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

関連タグ

カテゴリ別人気記事

もっと見る
テレワーク関連人気記事

週間人気記事

もっと見る