マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い（アップデートされていない） 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
製造・コーディング(PG/バックエンド)
【C++基礎】C++プログラマが学びなおす その２
C++からしばらく離れていたプログラマですが、これからの業務で触れる可能性が出てきたので、一度初心に立ち返って基礎からおさらいをしていく過程を備忘録として残していきます。
製造・コーディング(PG/フロントエンド)
【JavaとJavaScript】プログラミング言語の違いと選び方
プログラミングの世界に足を踏み入れようとする際、最初に直面する疑問の1つは、どのプログラミング言語を学ぶべきかということでしょう。特に初心者の場合、JavaとJavaScriptの2つの言語は名前が似ていることから混同されることがありますが、実際には全く異なる特性と用途を持つ言語です。本記事では、JavaとJavaScriptの違いを明らかにし、それぞれの言語の特徴や学習のメリットについて探求していきます。
初心者
【初心者必見】Python独学を通し、プログラミング入門についてまとめてみた
とあるきっかけからPythonに関心を持ちまして、手探りですが勉強をしてみました。 まだ入り口に片足踏み込んだ程度ですが、プログラミング初心者にとってはその難しい「一歩」の助けになればと思い、記事にしました。 当記事では、ざっくりと ・使用した教材、感じた利点 ・学習のコツ、簡単に応用力を伸ばしていける工夫 について、書いていきます。 プログラミング学習のコツについても解説していくので、Python初心者に留まらず、プログラミング自体が初めての方にも参考になると思います。 ※注意点！ ・本記事は、あくまで学習方法、コツについての解説です。Pythonって何？ どうコーディングすればいいの？ といった点に触れたものではありません。 ・本記事における学習ラインは、タイトルに「入門編」と書いた通り、変数の概念や条件分岐や繰り返し文といった初歩の初歩までです。機械学習やデータ分析といったディープな部分までを補完しうるものではありません。
製造・コーディング(PG/バックエンド)
【基本】AWSの使い方とその他
みなさんAWSを知っていますか。AWSは今どこの現場でも使われており、任天堂やフジテレビなどアプリではInstagramや漫画アプリなどでも大きく関連しており、今、AWSがないとほとんどのアプリに影響があるほど私たちの生活では必須になっております。そんなAWSについて今回はまとめました。
初心者
Java開発に必須のフレームワーク | Spring BootとSpringの違いを徹底解説！
Spring BootとSpringはどちらもJavaのWebアプリケーション開発に使われるフレームワークですが、それぞれに特徴やメリットがあります。この記事では、Spring BootとSpringの歴史や機能、使い方などを比較しながら、それぞれの違いを理解していきましょう。
JavaScriptの進化と現在の重要性 - Node.jsの役割
はるか昔、インターネットがこの世に広まり始めたころ、私はHTMLを書いていました。そしてjavascriptと出会い、時代とともに様々な変遷を経験してきました。そのたびに思ったことが、「今この技術は必要なのか？」でした。今回は、今すでに広く受け入れられている、Node.jsについて学んでいきたいと思います。
製造・コーディング(PG/バックエンド)
Spring Frameworkの解説とWebアプリケーションの作成
Webアプリケーション開発は、企業の情報システムを支える上で欠かせないものとなっています。その中でも、Java言語を利用したWebアプリケーション開発が注目を集めており、Java言語でWebアプリケーションを開発する場合、Spring Frameworkは必須の技術となります。本記事では、Spring Frameworkの導入からWebアプリケーションの作成方法までを解説します。
製造・コーディング(PG/バックエンド)
データ分析に使用されるR言語の基礎構文をまとめてみた
R言語は、統計解析やデータ分析に特化したプログラミング言語であり、初心者でも比較的簡単に学ぶことができます。今回はR言語の初心者向けにR言語の基礎を紹介しようと思います。
製造・コーディング(PG/バックエンド)
Java言語の一番メジャーなフレームワーク「Spring Framework」について解説
こんにちは、最近Javaのフレームワークに興味を持った者です。今回は、Java開発者にとって欠かせないフレームワークの一つ、Spring Frameworkについて実践形式で解説していきたいと思います。
製造・コーディング(PG/バックエンド)
機械学習エンジニアのキャリアパスと必要なスキルについて
機械学習は近年、急速に発展している分野であり、多くの企業や産業において重要な役割を果たしています。機械学習エンジニアは、データを分析し、予測モデルを開発するなど、機械学習技術を活用して問題を解決する専門家です。本記事では、機械学習エンジニアとしてのキャリアパスや、成功するために必要なスキルについて探っていきます。経験の浅い方々やキャリアを考えている方々にとって、参考になる情報を提供します。さあ、機械学習エンジニアとしての旅を始めましょう。
学習・スキル
関連タグ
カテゴリ別人気記事
もっと見るテレワーク関連人気記事
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/バックエンド)
【初心者向け】Packet Tracerでネットワークを学ぶ（CLI操作の基本編①）
ルータ初期設定編ではPacket Tracerを使ってルータを直接操作し色々な設定を試してみたいと思います。 まずCisco製品のルータにはPCと同様にOSがインストールされています。 それが「Cisco IOS(Internetwork Operating System)」です。 スイッチでもこのOSを利用しています。 Cisco IOSはWindowsのようなグラフィカルなインターフェースではなくコマンド入力のみで様々な操作を行うインターフェースになります。 コマンドで操作するインターフェースのことを「CLI(Command Line Interface）」と言います。
詳細設計(内部設計)(インフラ)
【初心者向け】テスト観点について
テスト観点（test perspective）とは、「ソフトウェアやシステムをテストする際に、評価すべき特定の側面や機能」を指します。テスト観点は、テストプロセスを計画、設計、実行する際に、目標となる品質要素を明確にすることで、効果的なテストケースを作成し、重要な問題を特定できるようにする役割があります。これは、製品やサービスの品質向上に大きく貢献する重要な要素であると言えます。
初心者
【初心者用】ifconfigの出力結果の見方
Linuxシステムでネットワーク設定や情報を確認するための基本的なコマンドの1つがifconfigです。この記事では、初心者向けにifconfigコマンドの使用方法、オプション、出力結果の解釈について詳しく説明します。また、具体的な使用シーンや例、関連するコマンドや技術についても紹介します。
その他(インフラ)