マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い(アップデートされていない) 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
製造・コーディング(PG/バックエンド)
イチから学ぶデータベース・SQL(4)
イチから学ぶデータベース・SQL(3)では、SQLの読みやすい書き方や間違いやすいポイントなど、実務でSQLを使っていく上での基本的なことについて学習しました。今回は、前回同様paizaラーニングを参考にし、より深くSQLについて学習していきます。
製造・コーディング(インフラ)
イチから学ぶデータベース・SQL(9)
イチから学ぶデータベース・SQL(8)では、テキスト検索について学習していきました。 今回も、これまでと同様paizaラーニングを参考に、オンラインRPGを題材としてSQLについて学習していきます。
製造・コーディング(インフラ)
【初心者用】CakePHPを学んでいこう①(基礎知識)
そもそも、PHPとは? Cake「PHP」とあるように、そもそもPHPとは何かをまずは確認していきましょう。 PHPは、1995年に登場したWebページやWebアプリケーションを作成する際に使用するプログラム言語です。 静的なWebページを表示するHTMLとは違い、ユーザがアクセスしたタイミングによってページ内容が変化する、動的なWebページを開発することができます。 PHPを使用して作成された有名なWebサービスに、WikipediaやFacebook、ぐるなびなどがあります。
製造・コーディング(PG/バックエンド)
【初心者用】CakePHPを学んでいこう③(モデルの作成とデータ更新)
前回はCakePHPのインストールから簡単な画面表示までをご紹介しました。 今回は前回の続きとなる、簡単なModelの作成と取得したデータベースのデータを更新するところまでご紹介いたします。
製造・コーディング(PG/バックエンド)
簡単にオンライン通信を実装できるライブラリ「Socket.io」について調べてみた|Node.js
リアルタイムWebアプリケーションにおいて、双方向通信は必須です。そのためには、WebSocketというプロトコルが使われますが、Socket.IOというライブラリを使うことで、より簡単にWebSocketを使った双方向通信を実現することができます。この記事では、Socket.IOについて分かりやすく説明していきます。
製造・コーディング(PG/バックエンド)
【初心者用】AWS基礎③
AWSの基礎レベルの知識を身につけるために、範囲に沿って学んでいきましょう。前回は、クラウドの概念、セキュリティのAWSの責任共有モデルについて学習してきました。続きからはじめていきたいと思います。
その他(インフラ)
スマホエンジニアに必要なスキルとは?役立つ資格や仕事内容もご紹介!
https://pixabay.com/ja/illustrations/%E3%82%B3%E3%83%B3%E3%83%94%E3%83%A5%E3%83%BC%E3%82%BF%E3%83%BC-%E3%82%B9%E3%83%9E%E3%83%BC%E3%83%88-%E3%83%95%E3%82%A9%E3%83%B3-1231889/
【初心者用】SQLのクエリ操作基礎1
次回の案件からSQLを使用することになったので、改めてSQLのクエリ操作について学びなおそうと思います。SQLはテストをするにも開発をするにも、使用することになるので基礎的な部分はしっかりとわかりやすくまとめます。
その他(PG/バックエンド)
【初心者用】SQLのクエリ操作基礎4
タイトル通りですが、SQL初心者がクエリ操作に関して学んだことまとめていきます。操作方法について忘れていることが分からないことが多いので、基礎を学んでいきます。
その他(PG/バックエンド)
ローコードについて(kintone)
近年、IT人材不足やクラウド技術の普及、環境の多様化などの理由から、プログラミングの知識がなくても画面や機能が作成できるローコード開発が注目されています。そこで、今回はローコード開発とローコード開発で代表的なkintoneを実際に使用してみて便利だと思った機能についての記事を作成します。
ヘルプデスクの仕事内容と必要なスキルは?エンジニアとしてのキャリアを考える
IT業界で働くエンジニアの中には、ヘルプデスクという職種に興味を持っている方も多いでしょう。ヘルプデスクの仕事は、エンジニアとしての経験やスキルを身につけるのに適しています。しかし、どのようなスキルや知識が必要なのでしょうか?また、ヘルプデスクの仕事を通じて、エンジニアとしてのキャリアをどのように築いていくことができるのでしょうか?この記事では、ヘルプデスクの仕事内容と必要なスキルについて解説します。ヘルプデスクに必要なスキルや学ぶべき知識を知りたい方は、ぜひ参考にしてください。
関連タグ
カテゴリ別人気記事
もっと見るテレワーク関連人気記事
2023年10月02日
製造・コーディング(PG/フロントエンド)2023年07月18日
アーキテクト・技術選定(PG/バックエンド)2023年10月26日
テスト(運用・保守・サポート)2023年11月17日
2023年01月09日
詳細設計(内部設計)(インフラ)
週間人気記事
もっと見る【これからJP1に触れる人向け】JP1とは
開発プロジェクトに携わる際にJP1というツールに触れたことはあるだろうか。JP1は開発工程、特にテスト作業においては非常に利便性の高いツールである。この記事ではまだJP1に触れたことがない人向けにJP1の概要やJP1を合う買う際に知っておくべき用語を取り上げる。
テスト(運用・保守・サポート)
インデックスとは?メリットデメリットやインデックスの種類も交えてご紹介
インデックスとは、データベースを扱う際には欠かすことのできない概念となります。インデックスの取り扱いによって、データのアクセス速度が大きく変わります。特に大規模なデータを扱う場合には、取り扱いに気をつけなくてはなりません。インデックスを設定した結果、処理速度が遅くなってしまうことやそもそもインデックスを使用するような実行計画が選択されないこともあるのです。インデックスは、DBMSの種類(例えば、OracleやMySQL、Postgreなど)によっても異なります。インデックスの仕様を知らないと、開発者にとって意図しない処理をしてしまう可能性もあります。そこで今回はインデックスについてメリットデメリットや具体的にどのような種類があるのかを説明していきます。
【初心者向け】Packet Tracerでネットワークを学ぶ(CLI操作の基本編①)
ルータ初期設定編ではPacket Tracerを使ってルータを直接操作し色々な設定を試してみたいと思います。 まずCisco製品のルータにはPCと同様にOSがインストールされています。 それが「Cisco IOS(Internetwork Operating System)」です。 スイッチでもこのOSを利用しています。 Cisco IOSはWindowsのようなグラフィカルなインターフェースではなくコマンド入力のみで様々な操作を行うインターフェースになります。 コマンドで操作するインターフェースのことを「CLI(Command Line Interface)」と言います。
詳細設計(内部設計)(インフラ)
CIとは何か?代表的なCIツールの特徴とメリット・デメリットを解説
CIとは、開発者がコードを頻繁に統合し、自動的にテストやビルドを行うことで、品質や効率を向上させる手法です。 CIを実現するためには、CIツールと呼ばれる専用のソフトウェアが必要です。 CIツールは、コードの変更を検知し、自動的にテストやビルドを実行し、結果を報告する機能を提供します。しかし、CIツールには様々な種類があり、それぞれに特徴やメリット・デメリットがあります。 では、どのようにしてCIツールを選ぶべきでしょうか? この記事では、代表的なCIツールの概要と選び方について解説します。
【初心者用】ASP.NETのサーバーコントロールの種類をまとめてみた~その2~
ASP.NET Webフォームで使われるサーバーコントロールについてまとめてみたので、メモがてら記事にします。 それぞれのサーバーコントロールについて、固有のプロパティ等を具体例を交えてざっくり説明していきます。 (ID等の共通するプロパティは別記事で説明しているため、今回は取り上げません) 今回説明するサーバーコントロールは、以下になります。 ・HyperLink コントロール ・CheckBox コントロール ・RadioButton コントロール サンプルコードの開発環境は、 ・Microsoft Visual Studio Community 2022 実行ブラウザは ・GoogleChrome です。
製造・コーディング(PG/バックエンド)
