マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い(アップデートされていない) 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
製造・コーディング(PG/バックエンド)
【初心者用】Javaの例外処理についてまとめてみた
Javaで記述したプログラムで発生するエラーは、大別して3つに分けられます。 コンパイル時に発生するコンパイルエラーと、プログラム実行時に発生する実行エラー、問題なく実行できるものの、期待できる結果になっていない論理エラーです。 今回は、その中の「実行エラー」に着目してみます。して、ただ「エラーが発生しました」というだけで終わらせるのではなく、発生したエラーに対して別途記述した処理を行わせるのが、例外処理となります。 今回は、その例外について、具体例を交えた解説とともに、例外処理の方法について解説していきます。
製造・コーディング(PG/バックエンド)
Gitの使い方
ツールのアップデートが頻繁に行われているWEB業界では、Gitを活用して業務を効率化させることが一般的になってきています。しかし、初心者の方や業界に馴染みのない方は、Gitが何のことかわからない方もきっといらっしゃるでしょう。多くの開発者に利用されている印象のあるGitですが、実はエンジニアだけではなく、WEBデザイナーやライターにとっても便利なツールのひとつです。Gitを活用することで、チームでの作業効率を高めたり、多くのファイルを管理することが簡単になります。というわけで本記事では、Gitについて基本的な用語について解説いたします。
学習・スキル
【初心者用】SQLのクエリ操作基礎3
タイトル通りですが、SQL初心者がクエリ操作に関して学んだことまとめていきます。操作方法について忘れていることが分からないことが多いので、基礎を学んでいきます。
その他(PG/バックエンド)
マークアップ言語でなにができる?その種類と活用法を紹介!
マークアップ言語とは、文書の構造や見た目を表現するための言語のことで、HTMLやXMLなどが有名です。マークアップ言語は、プログラミング言語とは異なり、命令や計算を行うことはできませんが、文書の意味やレイアウトを定義することができます。この記事では、マークアップ言語の特徴やできること、プログラミング言語との違いなどを紹介しながら、マークアップ言語の種類や用途についても説明していきます。
DBの基礎と、Microsoft Accessについて
皆さんは”Access”(アクセス)という言葉を聞いたことがありますか? Accessとは、Microsoft社が運営するツールで、主にデータ抽出、集計処理や、業務システムの開発環境や動作環境として使われております。 企業向けというよりかは個人向けのデータベースソフトですが、多機能であり、データベース以外にも、外部のデータベースを参照してデータ抽出やデータ集計をするためのBI(ビジネスインテリジェンス)ツールとしてや、帳票作成機能を活用した業務システムの開発環境、動作環境としても利用されるシーンが多いのが特徴です。 また、AccessにはVBAが標準搭載されているため、プログラミングを行うことも可能です。 プログラミングを行うことで、上記の活用方法をより高度に、より便利に実装することができます。 ただ、機能が多すぎるため、新しくAccessの使い方を習得しようとする場合は、覚えることが多い分、それだけ学習コストが高めとなっております。 今回の記事では、そんなAccessの機能と一般的なデータベース知識の紹介を併せて行っていこうと思います。
製造・コーディング(PG/バックエンド)
【初心者用】システム開発に用いられる設計書について
今回はシステム開発の現場で求められる、設計書の種類などについて解説していこうと思います。 設計書が読めるようになると、市場価値が上がるため高単価の案件に参画することも可能となります。 また、開発サイドではなくマネジメントサイドの仕事も行うことが可能となります。
製造・コーディング(PG/バックエンド)
【初心者用】JavaとJavaScriptの違いは?Javascriptで出来ることは?
JavaScript(ジャバスクリプト)は、プログラミング言語の一種です。 名前は聞いたことがあっても「実際に、どういうことに使われているのか?」「JavaScriptは何のジャンルが得意で、どういったことが実現できるのか?」ということまでは、あまり知られていないのではないでしょうか? 初心者の方で特に多いのが「Javaが得意な人は、JavaScriptも得意」という誤った認識です。 良く混同されがちですが、JavaとJavaScriptとはまったくの別物です。 では、具体的にどのような違いがあるのでしょうか? JavaScriptの詳しい説明も交えながら、JavaとJavaScriptの違いについてまとめてみました。
製造・コーディング(PG/バックエンド)
Javaを使ったオセロゲームの作成
今回はJavaでオセロゲームを作成したいと思います。 とりあえず何かゲームを作りたくてお手軽にできそうだったので オセロをコンソール画面を使って作っていきたいと思います。 環境 Eclipse(Version: 2022-09 (4.25.0)) Java17
製造・コーディング(PG/バックエンド)
【SQL入門】エンジニア1年目が知っておくべきSQLの基礎知識
エンジニアとしての1年目を迎えると、SQL(Structured Query Language)というデータベース操作言語に触れる機会が増えます。本記事では、SQL文の基礎から始めて、SELECT、INSERT、UPDATE、DELETEといった基本命令の使い方を解説します。エンジニアキャリアのスタートにふさわしいSQLスキルの習得に役立つ情報を提供します。
学習・スキル
AIエンジニアになるために必要なスキル | その仕事内容を解説
AI技術を用いたサービスは、スマートスピーカーやChatBOT、株価予想など、ここ数年で大きく普及しており、その応用範囲が拡大する中、AIエンジニアはベンチャーから大手企業までニーズのあるとても人気の職業です。この記事では、AIエンジニアになるためのロードマップとして、仕事内容、必要なスキル、有利な資格について詳しく解説します。技術の最先端をいくAIエンジニアは、一つのアイデアが人々の生活を大きく変化させ、新たなビジネスモデルを確立できるため、ゼロからイチを作れるクリエイティブさがAIエンジニアの仕事が持つ大きな魅力の一つです。
学習・スキル
関連タグ
カテゴリ別人気記事
もっと見るテレワーク関連人気記事
-
2023年10月02日
製造・コーディング(PG/フロントエンド) -
2023年07月18日
アーキテクト・技術選定(PG/バックエンド) -
2023年11月17日
学習・スキル -
2023年10月26日
-
2023年01月09日
詳細設計(内部設計)(インフラ)
週間人気記事
もっと見る【これからJP1に触れる人向け】JP1とは
開発プロジェクトに携わる際にJP1というツールに触れたことはあるだろうか。JP1は開発工程、特にテスト作業においては非常に利便性の高いツールである。この記事ではまだJP1に触れたことがない人向けにJP1の概要やJP1を合う買う際に知っておくべき用語を取り上げる。
Git GUIツールの使い方:初心者向けチュートリアル
Gitとは、分散型バージョン管理システムの1つで、コードやファイルなどの変更履歴を記録し、複数の人で同時に開発を進めるために使われます。Linuxの開発者であるLinus Torvaldsによって開発され、現在は世界中の多くの企業やオープンソースプロジェクトで使用されています。Gitは、ファイルの変更履歴を保存するための「リポジトリ」と呼ばれるデータベースを持ち、このリポジトリに対してコミットと呼ばれる操作で変更履歴を追加していきます。また、ブランチと呼ばれる分岐を作成して、異なるバージョンのコードを管理します。Gitの主な特徴としては、以下のようなものが挙げられます。・ローカルでの高速な動作・分散型であるため、オフラインでも開発ができる・変更履歴を管理しやすく、コードの品質を高めることができる・大規模なプロジェクトでもスケーラブルに対応可能Gitは、コマンドラインツールを使って操作することもできますが、GUIツールを使って操作することもできます。
アーキテクト・技術選定(PG/バックエンド)
DBのビューとは?メリットデメリットや使用方法についても紹介!
アプリケーション開発にとってデータベースは必須スキルとなっております。データベースの知識がないと、アプリケーション開発に難航することでしょう。しかしデータベースの知識を身に付けるとなると、かなりの勉強量を要します。というのもデータベースオブジェクトには様々な種類があり、一朝一夕では身に付くものではありません。今回は、データベースのビューについてご説明いたします。ビューそのものは必ず覚えてなくてはならないと言うものではありませんが、よく使われます。まずは本記事でビューの基礎知識を身に付けてください。本記事ではメリットデメリットや具体的な使用方法について紹介しております。
学習・スキル
インデックスとは?メリットデメリットやインデックスの種類も交えてご紹介
インデックスとは、データベースを扱う際には欠かすことのできない概念となります。インデックスの取り扱いによって、データのアクセス速度が大きく変わります。特に大規模なデータを扱う場合には、取り扱いに気をつけなくてはなりません。インデックスを設定した結果、処理速度が遅くなってしまうことやそもそもインデックスを使用するような実行計画が選択されないこともあるのです。インデックスは、DBMSの種類(例えば、OracleやMySQL、Postgreなど)によっても異なります。インデックスの仕様を知らないと、開発者にとって意図しない処理をしてしまう可能性もあります。そこで今回はインデックスについてメリットデメリットや具体的にどのような種類があるのかを説明していきます。
学習・スキル
GitHubのReadmeをMarkdown記法で書く
Markdown記法は、プレーンテキストに特定の書式を付けることで、簡単にWebページやドキュメントを作成するための記法です。Markdown記法は、文書の見た目を整えるためのHTMLタグを記述する必要がなく、テキストファイルとしても読み書きが容易であるため、多くの人々によって広く使用されています。
プロジェクト推進・管理(PG/バックエンド)
【初心者用】ifconfigの出力結果の見方
Linuxシステムでネットワーク設定や情報を確認するための基本的なコマンドの1つがifconfigです。この記事では、初心者向けにifconfigコマンドの使用方法、オプション、出力結果の解釈について詳しく説明します。また、具体的な使用シーンや例、関連するコマンドや技術についても紹介します。
その他(インフラ)
ECUとはなにか、まとめてみた
ECUとは、車載ECUにおける「ECU」とは、Electronic Control Unit(エレクトロニックコントロールユニット)の略称で、車両のあらゆるシステムを制御する装置の総称です。主にライトやドア、キーレスエントリーシステムなどの車両のボディに関する分野からブレーキ、エンジン、ステアリングなどの制御、オーディオやナビ、GPSなどの情報に関わる分野などもECUが用いられています。現在市販されている自動車には、およそ100個以上ものECUが搭載されており、さらにはハイブリッド車や電気自動車などの環境に対応した最新の自動車にもECUがなくてはならないものとなっています。自動車に関連するECUという用語は、Engine Control Unit(エンジンコントロールユニット)として捉えられることもあります。エンジンコントロールユニットとは、エンジンにおける運転制御を電子的に行うためのマイクロコンピューターのことです。現在ではエンジン制御だけでなく、自動車のあらゆる分野で役割を担っていることから、総称としてElectronic Control Unit(エレクトロニックコントロールユニット)として扱われています。なお、エンジンコントロールユニットの呼び名であり、自動車技術者協会(SAE)および国際標準化機構(ISO)で定義されているものは、ECM(Engine Control Module)と呼ばれます。車載ECUは、自動車に装備されているあらゆる機器やシステムを制御します。この働きによって、エンジン性能の向上や燃費の低減、排出ガスのクリーン化、運転性(ドライバビリティ)の向上などを目指すのが、ECU搭載の目的です。自動車業界の大きな変革期である今、世界中の各自動車メーカーは自社が誇る最新技術を用いて自動車の環境性能や快適性能、安全性能の向上に力を注いでいます。自動運転技術など、これからの自動車においてさまざまな最新機能の司令塔を担うECUは今後の技術発展において必要不可欠なものになっています。
開発環境関連(PG/フロントエンド)