マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い(アップデートされていない) 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
製造・コーディング(PG/バックエンド)
Oracle学習1
私はSQLに関しては、SQLServerでの開発をしてきましたが、いただく案件にOracleでの開発という文言をよく見かけます。そのため、自分の学習を兼ねて気になった記事について学習を深めていこうと思いました。
製造・コーディング(インフラ)
【初心者】JavaScript
JavaScriptとは、動的なWebページを作るためのプログラミング言語の一つです。代表的な機能は、ボタンを押すと画面に別ウィンドウが開く「ポップアップウィンドウ」や、画像が自動送りされる「スライドショー(スライダー)」などの多様なアニメーションです。その他、システムやアプリ開発などのバックエンドでも用いられています。
初心者
【初心者向け】テスト自動化について
テスト自動化とは、人の手によって行われるソフトウェアテストの全体あるいは一部を自動化することを意味します。そもそもソフトウェアテストは、不具合を見つけることが目的です。そのため、テストを繰り返し行うことも増えています。テスト自動化によって、テストにかかる人的負担を減らし、将来的なコストの削減が期待できます。
初心者
【HTML】さまざまなタグ | Part 2
今回は、HTMLのさまざまなタグについてまとめました。HTMLは、Web開発をするにあたって欠かせない知識となっています。ぜひ最後までお読みください!
製造・コーディング(PG/フロントエンド)
【選び方ガイド】おすすめのスマホアプリ開発言語とその将来性
スマートフォンアプリの開発に取り組む際、適切なプログラミング言語を選ぶことが重要です。しかし、初めてのプロジェクトや多くの選択肢がある中で、どの言語を選ぶべきか悩むこともあるでしょう。本記事では、スマホアプリ開発における言語選びのポイントを解説します。
学習・スキル
Gitの使い方
ツールのアップデートが頻繁に行われているWEB業界では、Gitを活用して業務を効率化させることが一般的になってきています。しかし、初心者の方や業界に馴染みのない方は、Gitが何のことかわからない方もきっといらっしゃるでしょう。多くの開発者に利用されている印象のあるGitですが、実はエンジニアだけではなく、WEBデザイナーやライターにとっても便利なツールのひとつです。Gitを活用することで、チームでの作業効率を高めたり、多くのファイルを管理することが簡単になります。というわけで本記事では、Gitについて基本的な用語について解説いたします。
学習・スキル
単体テストとは
単体テスト(ユニットテストと呼ばれることもあります)は、プログラムを構成する比較的小さな単位(ユニット)が個々の機能を正しく果たしているかどうかを検証するテストです。通常、関数やメソッドが単体テストの単位(ユニット)となります。 プログラムが全体として正しく動作しているかを検証する結合テストは、開発の比較的後の段階でQAチームなどによって行なわれることが多いのとは対照的に、単体テストは、コード作成時などの早い段階で開発者によって実施されることが多いのが特徴です。
初心者
【通信プロトコル】SSL/TLSについて
みなさんは、httpやhttpsなどをよく目にすると思います。このhttpやhttpsのことをプロトコルといいます。今回はそのプロトコルについて解説するのですが、プロトコルにはかなり沢山の種類があります。その中で「SSL/TLS」について、本日はご紹介していきます。プロトコルとは何かというところから、この「SSL/TLS」がどういった場面で使用されているのかを具体例をあげながら紹介していきます。
学習・スキル
【Java】アクセス修飾子についてまとめてみた
今回はアクセス修飾子についてまとめてみます。Javaには4つのアクセス修飾子があり、クラス・メンバフィールド・メソッドの他クラスへの公開範囲を決める修飾子を意味するものです。修飾子とはプログラム言語で、変数、関数、クラスなどの要素を振る舞いや性質を変更するキーワードのことです。修飾子は、その要素がどのように動作し、他の部分とどのように関連するかを制御するために使用されます。下記で示した4つのアクセス修飾子は、プログラムのセキュリティ、カプセル化、情報隠蔽などの様々な目的で使用されます。
学習・スキル
関連タグ
カテゴリ別人気記事
もっと見るテレワーク関連人気記事
2023年10月02日
製造・コーディング(PG/フロントエンド)2023年07月18日
アーキテクト・技術選定(PG/バックエンド)2023年11月17日
学習・スキル2023年10月26日
テスト(運用・保守・サポート)2023年01月09日
詳細設計(内部設計)(インフラ)
週間人気記事
もっと見る【初心者用】CakePHPを学んでいこう⑤(Validation)
前回はbakeコマンドの実行方法と、お問い合わせフォームの作成方法を紹介しました。 今回はバリデーション機能について、実装方法をご紹介いたします。
製造・コーディング(PG/バックエンド)
【初心者向け】Packet Tracerでネットワークを学ぶ(インストール編)
ネットワークエンジニアとしてCisco社のルータやスイッチの運用業務を遂行するには、 コマンドの知識やどのように機器が通信させているかよく理解しておく必要があります。 またCCNAといったネットワークのベンダー資格でも実際にコマンドを記述するシミュレーション問題が出題されることもあるので、自身のネットワークスキル向上には日頃からコマンド操作に慣れておく必要があります。 知識を定着や操作の慣れには座学だけでなく実際に機器に触れコマンドを入力し結果を確認することが一番なのですが、ルータやスイッチ等のネットワーク機器はいずれも高額であり、中古でもそれなりの値段となるので初心者が自宅に環境を作成することは簡単ではありません。 そこでCisco社のルータやスイッチに簡単に機器の設定、環境の構築、コマンドの投入練習といったことができるアプリケーションが「Packet Tracer」となります。
詳細設計(内部設計)(インフラ)
【初心者用】CakePHPを学んでいこう⑩(プラグイン)
前回はバッチ処理について、CakePHPでのバッチ処理の作成方法について紹介しました。今回はプラグインとは何か、そしてCakePHPで実際にプラグインを使用する方法をご紹介いたします。
製造・コーディング(PG/バックエンド)
Git GUIツールの使い方:初心者向けチュートリアル
Gitとは、分散型バージョン管理システムの1つで、コードやファイルなどの変更履歴を記録し、複数の人で同時に開発を進めるために使われます。Linuxの開発者であるLinus Torvaldsによって開発され、現在は世界中の多くの企業やオープンソースプロジェクトで使用されています。Gitは、ファイルの変更履歴を保存するための「リポジトリ」と呼ばれるデータベースを持ち、このリポジトリに対してコミットと呼ばれる操作で変更履歴を追加していきます。また、ブランチと呼ばれる分岐を作成して、異なるバージョンのコードを管理します。Gitの主な特徴としては、以下のようなものが挙げられます。・ローカルでの高速な動作・分散型であるため、オフラインでも開発ができる・変更履歴を管理しやすく、コードの品質を高めることができる・大規模なプロジェクトでもスケーラブルに対応可能Gitは、コマンドラインツールを使って操作することもできますが、GUIツールを使って操作することもできます。
アーキテクト・技術選定(PG/バックエンド)
DBのビューとは?メリットデメリットや使用方法についても紹介!
アプリケーション開発にとってデータベースは必須スキルとなっております。データベースの知識がないと、アプリケーション開発に難航することでしょう。しかしデータベースの知識を身に付けるとなると、かなりの勉強量を要します。というのもデータベースオブジェクトには様々な種類があり、一朝一夕では身に付くものではありません。今回は、データベースのビューについてご説明いたします。ビューそのものは必ず覚えてなくてはならないと言うものではありませんが、よく使われます。まずは本記事でビューの基礎知識を身に付けてください。本記事ではメリットデメリットや具体的な使用方法について紹介しております。
学習・スキル
【初心者用】CakePHPを学んでいこう①(基礎知識)
そもそも、PHPとは? Cake「PHP」とあるように、そもそもPHPとは何かをまずは確認していきましょう。 PHPは、1995年に登場したWebページやWebアプリケーションを作成する際に使用するプログラム言語です。 静的なWebページを表示するHTMLとは違い、ユーザがアクセスしたタイミングによってページ内容が変化する、動的なWebページを開発することができます。 PHPを使用して作成された有名なWebサービスに、WikipediaやFacebook、ぐるなびなどがあります。
製造・コーディング(PG/バックエンド)
【VMware Horizon】仮想デスクトップの構築
VMware Horizonとは、VDI化(デスクトップ仮想化)を実現するための仮想ソフトウェアの1つです。VMware Horizonは、いくつかの基本コンポーネントによって構成された仮想ソフトウェアになります。VMware Horizonは企業のシステム環境に合わせて、オンプレミスでもクラウドでも利用できます。
その他(インフラ)
時間と場所に縛られない!リモート勤務に必要なエンジニアのスキルを公開!
コロナ禍でシステム業界以外でもリモート勤務が導入され、新しい働き方のかたちが定着しつつある昨今ですね。しかし客先常駐が基本のSES企業では、セキュリティや仕事の生産性の低下が理由でリモート勤務ができない案件もあります。一方で、大手のSIer企業では、オフィスを解約してフルリモートを導入している企業もあり、一軒家を購入して地方移住したり、自然豊かな場所に移り住んで趣味の時間を楽しむ人がいるのも事実です。SESの働き方に不安を覚えて転職を考えられている方も多いでしょう。本記事ではそのような方に向けて、システム業界で2年以上のリモート勤務を経験する筆者が、リモート勤務のメリット・デメリット、リモート勤務に必要なスキルをご紹介します。
働き方