マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い(アップデートされていない) 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
製造・コーディング(PG/バックエンド)
【初心者用】はじめてのC言語3
前回の【初心者用】はじめてのC言語2では、四則演算と条件分岐式if文、if文に使用する演算子について解説を行いました。今回はif文の場合分け処理から解説していければと思います。
1年目のインフラエンジニアに必要なスキル | データモデリングとは?
データモデリングは、ビジネス要件に必要な情報を整理してビジュアル化し、データ検索を容易にする、システムがデータの精度を保つために必要な概念です。特にインフラエンジニアやデータベースエンジニアの方など、データに深く関わる職種では重要なスキルであり、これからエンジニアとしてキャリアを築いていくためには避けて通れません。本記事では、エンジニアに必要なスキルの一つであるデータモデリングについて分かりやすく解説します。
AIエンジニアになるために必要なスキル | その仕事内容を解説
AI技術を用いたサービスは、スマートスピーカーやChatBOT、株価予想など、ここ数年で大きく普及しており、その応用範囲が拡大する中、AIエンジニアはベンチャーから大手企業までニーズのあるとても人気の職業です。この記事では、AIエンジニアになるためのロードマップとして、仕事内容、必要なスキル、有利な資格について詳しく解説します。技術の最先端をいくAIエンジニアは、一つのアイデアが人々の生活を大きく変化させ、新たなビジネスモデルを確立できるため、ゼロからイチを作れるクリエイティブさがAIエンジニアの仕事が持つ大きな魅力の一つです。
【必見】AIエンジニアの需要と将来性について
AI(人工知能)の発展により、AIエンジニアの需要が急速に拡大しています。AI技術は様々な産業や分野において革新的な変化をもたらし、企業はその力を活用するためにAIエンジニアを積極的に採用しています。本記事では、AIエンジニアの需要の高まりと将来性、そしてAIエンジニアになるために必要なスキルについて詳しく探っていきます。
【初心者用】Pythonが何なのかメリット・デメリットの面からまとめてみた
エンジニアとしてのキャリアが短く、データベース・SQLについて疎い自分がデータベースとSQLについて基本から学びながら、データベースとは何か、SQLとは何かを分かりやすいように説明していきます。
製造・コーディング(インフラ)
システム開発のテスト工程で重要な事とは?
システム開発では、不具合やバグが無いかを検証するテスト工程と呼ばれる期間が存在します。 テスト工程には大きく分けて下記4つのテスト内容が存在します。 ・単体テスト・・画面や機能ごとに、動作の検証をする ・結合テスト・・他の機能やシステムと連携させて、動作の検証をする ・総合テスト・・本運用を想定して、システム全体の動作を検証する・ 受入れテスト・・納品前に仕様書の通り完成しているか確認する システム開発におけるテストの役割は、開発したシステム、記述したプログラムが不具合なく動作するか、バグなどがないかをチェックして修正する工程のことを指します。 どれだけ優秀なエンジニアが開発していようと、人の手が介在するシステム開発では、バグがないということは絶対にあり得ません。 たとえば、システム開発の現場でもっともポピュラーな開発の流れの「ウォーターフォール型」を採用している場合、「単体テスト」「結合テスト」「システムテスト(総合テスト)」「受け入れテスト(ユーザーテスト)」の、大きく4つのテスト工程が実施されます。
製造・コーディング(PG/バックエンド)
【初心者用】Pythonでできることについて
現在、最も注目を集めているプログラミング言語の1つといわれているのが、今回紹介する「Python (パイソン)」です。 Pythonの特長としては、人工知能(機械学習や深層学習)などの最先端分野の開発にも使われている一方、プログラムの記述方法が簡単なため、 プログラミングを始めたばかりの初心者の方でも大規模なWebアプリケーション開発が短期間でできることがあげられます。 今回は、そんなPython の魅力について詳しくご紹介します。
製造・コーディング(PG/バックエンド)
【SQL入門】エンジニア1年目が知っておくべきSQLの基礎知識
エンジニアとしての1年目を迎えると、SQL(Structured Query Language)というデータベース操作言語に触れる機会が増えます。本記事では、SQL文の基礎から始めて、SELECT、INSERT、UPDATE、DELETEといった基本命令の使い方を解説します。エンジニアキャリアのスタートにふさわしいSQLスキルの習得に役立つ情報を提供します。
Microsoft Azureについてまとめてみた
・Microsoft Azureは聞いた事あるけど、実際どんなものなのか使ったこと無い・プログラミングに興味がある人じゃないと使うことが無いと、機会がないと触れることが無いので、Azureとはどんなものかをまとめてみました。
開発環境関連(インフラ)
RPA開発とは?メリットや開発手法、将来性について解説
近年、RPAは働き方改革や生産性向上のために注目されており、多くの企業が導入を検討しています。しかし、RPAを導入するには、どのような開発手法があるのでしょうか?また、RPA開発にはどのようなメリットや費用がかかるのでしょうか?この記事では、RPA開発について、メリットや開発手順・費用について解説します。
関連タグ
カテゴリ別人気記事
もっと見るテレワーク関連人気記事
2023年10月02日
製造・コーディング(PG/フロントエンド)2023年07月18日
アーキテクト・技術選定(PG/バックエンド)2023年10月26日
テスト(運用・保守・サポート)2023年11月17日
2023年01月09日
詳細設計(内部設計)(インフラ)
週間人気記事
もっと見る【これからJP1に触れる人向け】JP1とは
開発プロジェクトに携わる際にJP1というツールに触れたことはあるだろうか。JP1は開発工程、特にテスト作業においては非常に利便性の高いツールである。この記事ではまだJP1に触れたことがない人向けにJP1の概要やJP1を合う買う際に知っておくべき用語を取り上げる。
テスト(運用・保守・サポート)
DBのビューとは?メリットデメリットや使用方法についても紹介!
アプリケーション開発にとってデータベースは必須スキルとなっております。データベースの知識がないと、アプリケーション開発に難航することでしょう。しかしデータベースの知識を身に付けるとなると、かなりの勉強量を要します。というのもデータベースオブジェクトには様々な種類があり、一朝一夕では身に付くものではありません。今回は、データベースのビューについてご説明いたします。ビューそのものは必ず覚えてなくてはならないと言うものではありませんが、よく使われます。まずは本記事でビューの基礎知識を身に付けてください。本記事ではメリットデメリットや具体的な使用方法について紹介しております。
【初心者用】SQL インデックスとビューについてまとめてみた
参考サイト https://style.potepan.com/articles/25208.html SQLのインデックスとは? 作成、確認、削除方法からメリットまで解説! https://medium-company.com/sql-index/ SQL インデックス(INDEX)を作成・削除する http://dbonline.s25.xrea.com/sqlite/index/index3.html UNIQUEインデックス https://www.sejuku.net/blog/52356 SQL入門 PRIMARY KEY(主キー)制約とは? 追加や削除についても解説 https://style.potepan.com/articles/26878.html SQL 主キー(PRIMARY KEY)制約って何? サンプルコードで基本的な使い方を確認しよう! https://smallit.co.jp/blog/a1015/ BLOG SQLのビューについて https://products.sint.co.jp/siob/blog/view ビューとは? 使い方を解説 https://style.potepan.com/articles/25504.html SQLのビューって何? 基本的な使い方を理解しよう https://cs.wingarc.com/manual/drsum/5.5/ja/UUID-3b6e70a4-5a0d-205e-4b2b-fcb2df959cfd.html ALTER VIEW ビューの定義を変更する
製造・コーディング(SE)
GitHubのReadmeをMarkdown記法で書く
Markdown記法は、プレーンテキストに特定の書式を付けることで、簡単にWebページやドキュメントを作成するための記法です。Markdown記法は、文書の見た目を整えるためのHTMLタグを記述する必要がなく、テキストファイルとしても読み書きが容易であるため、多くの人々によって広く使用されています。
プロジェクト推進・管理(PG/バックエンド)
【初心者向け】Packet Tracerでネットワークを学ぶ(CLI操作の基本編①)
ルータ初期設定編ではPacket Tracerを使ってルータを直接操作し色々な設定を試してみたいと思います。 まずCisco製品のルータにはPCと同様にOSがインストールされています。 それが「Cisco IOS(Internetwork Operating System)」です。 スイッチでもこのOSを利用しています。 Cisco IOSはWindowsのようなグラフィカルなインターフェースではなくコマンド入力のみで様々な操作を行うインターフェースになります。 コマンドで操作するインターフェースのことを「CLI(Command Line Interface)」と言います。
詳細設計(内部設計)(インフラ)
オブジェクト指向プログラミングとは?その特徴と代表的な言語を紹介
プログラミングというと、難しくて理解しにくいものと思われがちですが、実は私たちの身の回りにあるものや現象をモデル化して表現する方法の一つです。プログラミングにはさまざまな種類や手法がありますが、その中でも最も一般的で人気の高いものがオブジェクト指向プログラミングです。では、オブジェクト指向プログラミングとは、どのようなものなのでしょうか?また、どのような特徴やメリットがあるのでしょうか?この記事では、オブジェクト指向プログラミングの基礎と特徴、そして代表的な言語を紹介します。
【HTML】さまざまなタグ | Part 2
今回は、HTMLのさまざまなタグについてまとめました。HTMLは、Web開発をするにあたって欠かせない知識となっています。ぜひ最後までお読みください!
製造・コーディング(PG/フロントエンド)
