マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い（アップデートされていない） 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
製造・コーディング(PG/バックエンド)
CCNA学習＃３未経験の方向けイーサネットについて
本日はイーサネットについて、まとめていきたいと思います。主に、データリンク層についてのお話になりますので、まずは簡単にデータリンク層について、復習していきたいと思います。
その他(インフラ)
C言語とは何か
C言語とは、1972年に開発された歴史の深いプログラミング言語の1つです。アメリカ、AT&T社ベル研究所のDennis.M. Ritchie（デニス・M・リッチー）氏とBrian.W.Kernighan（ブライアン・W・カーニハン）氏によって開発されました。現在は、開発元であるアメリカ国内のみならず世界中に普及しているほか、「C++」や「C#」のようにC言語から発展したプログラミング言語も数多く存在します。プログラミングの基礎知識から、実用性の高い応用力まで幅広く習得できることから、プログラミングを学ぶうえで、最初にC言語を選択する方も少なくありません。
製造・コーディング(PG/フロントエンド)
JavaScriptの進化と現在の重要性 - Node.jsの役割
はるか昔、インターネットがこの世に広まり始めたころ、私はHTMLを書いていました。そしてjavascriptと出会い、時代とともに様々な変遷を経験してきました。そのたびに思ったことが、「今この技術は必要なのか？」でした。今回は、今すでに広く受け入れられている、Node.jsについて学んでいきたいと思います。
製造・コーディング(PG/バックエンド)
ローコードについて(kintone)
近年、IT人材不足やクラウド技術の普及、環境の多様化などの理由から、プログラミングの知識がなくても画面や機能が作成できるローコード開発が注目されています。そこで、今回はローコード開発とローコード開発で代表的なkintoneを実際に使用してみて便利だと思った機能についての記事を作成します。
初心者
クラウドの運用設計について
システムを安定して運用していくには、「運用設計」と呼ばれるプロセスが欠かせません。運用設計の概要や、必要な項目、作成のポイントなどを説明していきます。システム開発の依頼を受ける企業は、システムを安定的にサービス提供させてこそ、クライアントの満足度が上がります。クラウドの運用設計について話していきますが、実はオンプレミスでもクラウドでも取り決める要件や設計自体には大きな差はないですが、クラウドの利点を活用するために、共同責任モデルと、クラウドネイティブを意識した設計は必要になってきます。
その他(インフラ)
sts4+JUnit5+Selenium4+Chromeを使ってみる
Seleniumをつかうと、結合テストを自動化した上にスクショまで取ってくれるということでしたが、前回はうまくいきませんでした。そこで今回は、Selenium4でリベンジしたいと思います。
テスト(PG/バックエンド)
【エンジニアになりたい人必見！】システム開発について
今回はシステム開発の流れや、関連する用語についてまとめました。エンジニアになりたい方に、役立つ内容となっています。ぜひ最後までお読みください！
開発計画(SE)
【初心者向け】Packet Tracerでネットワークを学ぶ（NAT）
NATとはNetwork Address Translationの略称でIPアドレスを変換する技術です。 インターネットに接続する際にプライベートIPアドレスをグローバルIPアドレスに変換します。
詳細設計(内部設計)(インフラ)
Java開発に必須のフレームワーク | Spring BootとSpringの違いを徹底解説！
Spring BootとSpringはどちらもJavaのWebアプリケーション開発に使われるフレームワークですが、それぞれに特徴やメリットがあります。この記事では、Spring BootとSpringの歴史や機能、使い方などを比較しながら、それぞれの違いを理解していきましょう。
テスト自動化ツールとは？メリットデメリットやオススメツールもご紹介！
皆さんはテスト自動化ツールについてご存じでしょうか。開発プロセスにおいて必要不可欠な工程としてテスト工程がありますが、そのテストを自動化して膨大な工数を削減することができるツールとなっております。また人がテストをしていてはどうしてもミスが生じてしまいますが、テスト自動化ツールの場合は自動で行ってくれるので使い方さえ間違えなければミスが発生することはありません。特に大規模なプロジェクトになるほど効果を発揮してくれるテスト自動化ツールについて今回はご紹介いたします。
学習・スキル
関連タグ
カテゴリ別人気記事
もっと見るテレワーク関連人気記事
2023年10月02日
製造・コーディング(PG/フロントエンド)2023年07月18日
アーキテクト・技術選定(PG/バックエンド)2023年11月17日
学習・スキル2023年10月26日
テスト(運用・保守・サポート)2023年01月09日
詳細設計(内部設計)(インフラ)
週間人気記事
もっと見るGit GUIツールの使い方：初心者向けチュートリアル
Gitとは、分散型バージョン管理システムの1つで、コードやファイルなどの変更履歴を記録し、複数の人で同時に開発を進めるために使われます。Linuxの開発者であるLinus Torvaldsによって開発され、現在は世界中の多くの企業やオープンソースプロジェクトで使用されています。Gitは、ファイルの変更履歴を保存するための「リポジトリ」と呼ばれるデータベースを持ち、このリポジトリに対してコミットと呼ばれる操作で変更履歴を追加していきます。また、ブランチと呼ばれる分岐を作成して、異なるバージョンのコードを管理します。Gitの主な特徴としては、以下のようなものが挙げられます。・ローカルでの高速な動作・分散型であるため、オフラインでも開発ができる・変更履歴を管理しやすく、コードの品質を高めることができる・大規模なプロジェクトでもスケーラブルに対応可能Gitは、コマンドラインツールを使って操作することもできますが、GUIツールを使って操作することもできます。
アーキテクト・技術選定(PG/バックエンド)
【これからJP1に触れる人向け】JP1とは
開発プロジェクトに携わる際にJP1というツールに触れたことはあるだろうか。JP1は開発工程、特にテスト作業においては非常に利便性の高いツールである。この記事ではまだJP1に触れたことがない人向けにJP1の概要やJP1を合う買う際に知っておくべき用語を取り上げる。
テスト(運用・保守・サポート)
DBのビューとは？メリットデメリットや使用方法についても紹介！
アプリケーション開発にとってデータベースは必須スキルとなっております。データベースの知識がないと、アプリケーション開発に難航することでしょう。しかしデータベースの知識を身に付けるとなると、かなりの勉強量を要します。というのもデータベースオブジェクトには様々な種類があり、一朝一夕では身に付くものではありません。今回は、データベースのビューについてご説明いたします。ビューそのものは必ず覚えてなくてはならないと言うものではありませんが、よく使われます。まずは本記事でビューの基礎知識を身に付けてください。本記事ではメリットデメリットや具体的な使用方法について紹介しております。
学習・スキル
インデックスとは？メリットデメリットやインデックスの種類も交えてご紹介
インデックスとは、データベースを扱う際には欠かすことのできない概念となります。インデックスの取り扱いによって、データのアクセス速度が大きく変わります。特に大規模なデータを扱う場合には、取り扱いに気をつけなくてはなりません。インデックスを設定した結果、処理速度が遅くなってしまうことやそもそもインデックスを使用するような実行計画が選択されないこともあるのです。インデックスは、DBMSの種類（例えば、OracleやMySQL、Postgreなど）によっても異なります。インデックスの仕様を知らないと、開発者にとって意図しない処理をしてしまう可能性もあります。そこで今回はインデックスについてメリットデメリットや具体的にどのような種類があるのかを説明していきます。
学習・スキル
GitHubのReadmeをMarkdown記法で書く
Markdown記法は、プレーンテキストに特定の書式を付けることで、簡単にWebページやドキュメントを作成するための記法です。Markdown記法は、文書の見た目を整えるためのHTMLタグを記述する必要がなく、テキストファイルとしても読み書きが容易であるため、多くの人々によって広く使用されています。
プロジェクト推進・管理(PG/バックエンド)
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/フロントエンド)
【初心者用】ifconfigの出力結果の見方
Linuxシステムでネットワーク設定や情報を確認するための基本的なコマンドの1つがifconfigです。この記事では、初心者向けにifconfigコマンドの使用方法、オプション、出力結果の解釈について詳しく説明します。また、具体的な使用シーンや例、関連するコマンドや技術についても紹介します。
その他(インフラ)
【初心者用】MySQLを使用したDB構築１
タイトル通りですが、SQL初心者がクエリ操作に関して学んだことまとめていきます。操作方法について忘れていることが分からないことが多いので、基礎を学んでいきます。
その他(PG/バックエンド)