マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い（アップデートされていない） 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
製造・コーディング(PG/バックエンド)
【HTML】さまざまなタグ | Part 3
今回は、HTMLのさまざまなタグについてまとめました。HTMLは、Web開発をするにあたって欠かせない知識となっています。ぜひ最後までお読みください！
製造・コーディング(PG/フロントエンド)
【初心者用】CakePHPを学んでいこう⑥（メール機能）
前回はCakePHPのバリデーション機能についての説明・実装方法について紹介しました。 今回はローカル環境でメールを送信する方法についてご紹介します。
製造・コーディング(PG/バックエンド)
GitHub Actions でCIテスト・デプロイハンズオン
アジャイル開発ではスプリントを決めて開発を行い、修正を都度対応する必要があるため、スピード感を求められる開発現場が多い。そのため、継続的インテグレーション（CI）や継続的デリバリー/継続的デプロイ（CD)を導入し、マージやデプロイのコストを下げ、効率的な開発を実施したいが、初期導入コストや学習コストなど様々な観点から実施が見送られるケースも少なくない。今回はCI/CDを学習し、プロジェクトに対して現実的に導入する際のメリット・デメリットに関して言及していきます。
その他(PG/バックエンド)
【HTML】さまざまなタグ | Part 1
今回は、マークアップ言語のHTMLについてまとめました。HTMLは、Web開発をするにあたって欠かせない知識となっています。ぜひ最後までお読みください！
製造・コーディング(PG/フロントエンド)
【JavaとJavaScript】プログラミング言語の違いと選び方
プログラミングの世界に足を踏み入れようとする際、最初に直面する疑問の1つは、どのプログラミング言語を学ぶべきかということでしょう。特に初心者の場合、JavaとJavaScriptの2つの言語は名前が似ていることから混同されることがありますが、実際には全く異なる特性と用途を持つ言語です。本記事では、JavaとJavaScriptの違いを明らかにし、それぞれの言語の特徴や学習のメリットについて探求していきます。
【パート２】Node.jsでWebオンライン3Dゲーム作ってみる｜ダウンロード不要
前回はひとまずThree.jsを使用し、3D空間の描画を行いました。まだまだ描画できただけで、3Dゲームとはほど遠い物になっていますが、ここから徐々に近づけていきたいと思います。
製造・コーディング(PG/バックエンド)
#10営業インタビュー【エンジニアの価値を高める仕事とは？】
― 単価10万円アップを実現したリアルな話 ―こんにちは！採用担当です😊今回は、当社で活躍する営業メンバーにインタビュー🎤 エンジニアと企業をつなぐ“営業のリアル”について、ちょっと深掘りしてみました！
【初心者用】JavaScriptについて少しかじってまとめてみた
タイトル通り、JavaScriptについて勉強してみて、得た知識を軽くまとめていこうと思います。 初心者用、とある通り、極力専門用語は使わないか、噛み砕いて説明していきます。
製造・コーディング(PG/バックエンド)
＃09 社員インタビュー【育児もキャリアも、どちらも大切にしたい。フロントエンドエンジニアとして働く、私のリアルな毎日】
こんにちは！今回は、ラーニンギフトで活躍中のフロントエンドエンジニアにインタビュー🎤育児と仕事を両立しながら、自分らしいキャリアを歩んでいる社員のリアルな声をお届けします！「エンジニアとして成長したい」「でも、子どもとの時間も諦めたくない」そんな想いを持っている方に、ぜひ読んでほしい内容です😊
【初心者用】javaで出来ることとは？
Javaはプログラミング言語の中でも、昔からエンジニアの圧倒的な支持率とシェア率を持ち、言語の人気では常に上位に位置するプログラミング言語です。 Javaで開発されているシステムはWebサービスから業務系システム、組み込み、スマホアプリまで非常に多岐にわたり、様々な業界、様々な分野の開発現場でjavaは採用されています。 何でもできる汎用性の高さから、エンジニアを目指す際にJavaを習得しようと考える人も多いのが現状です。
製造・コーディング(PG/バックエンド)
【一日目】Java学習
Javaとはプログラミング言語の一種であり、コンピュータに仕事を指示するための言語です。 コンピュータに指示するためにはコンピュータが理解できる機械語で指示をしなくてはならないため、 Javaのようなプログラミング言語を用いる必要がある。
製造・コーディング(PG/バックエンド)
関連タグ
カテゴリ別人気記事
もっと見るテレワーク関連人気記事
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）」と言います。
詳細設計(内部設計)(インフラ)
【初心者向け】Packet Tracerでネットワークを学ぶ（インストール編）
ネットワークエンジニアとしてCisco社のルータやスイッチの運用業務を遂行するには、 コマンドの知識やどのように機器が通信させているかよく理解しておく必要があります。 またCCNAといったネットワークのベンダー資格でも実際にコマンドを記述するシミュレーション問題が出題されることもあるので、自身のネットワークスキル向上には日頃からコマンド操作に慣れておく必要があります。 知識を定着や操作の慣れには座学だけでなく実際に機器に触れコマンドを入力し結果を確認することが一番なのですが、ルータやスイッチ等のネットワーク機器はいずれも高額であり、中古でもそれなりの値段となるので初心者が自宅に環境を作成することは簡単ではありません。 そこでCisco社のルータやスイッチに簡単に機器の設定、環境の構築、コマンドの投入練習といったことができるアプリケーションが「Packet Tracer」となります。
詳細設計(内部設計)(インフラ)
【初心者向け】Packet Tracerでネットワークを学ぶ（DHCP）
DHCP(Dynamic Host Configuration Protocol)は自動的にIPアドレスやサブネットマスク等をPCやルータに配布してくれるプロトコルです。
詳細設計(内部設計)(インフラ)
GitHubのReadmeをMarkdown記法で書く
Markdown記法は、プレーンテキストに特定の書式を付けることで、簡単にWebページやドキュメントを作成するための記法です。Markdown記法は、文書の見た目を整えるためのHTMLタグを記述する必要がなく、テキストファイルとしても読み書きが容易であるため、多くの人々によって広く使用されています。
プロジェクト推進・管理(PG/バックエンド)
#10営業インタビュー【エンジニアの価値を高める仕事とは？】
― 単価10万円アップを実現したリアルな話 ―こんにちは！採用担当です😊今回は、当社で活躍する営業メンバーにインタビュー🎤 エンジニアと企業をつなぐ“営業のリアル”について、ちょっと深掘りしてみました！