マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い（アップデートされていない） 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
製造・コーディング(PG/バックエンド)
【HTML】さまざまなタグ | Part 3
今回は、HTMLのさまざまなタグについてまとめました。HTMLは、Web開発をするにあたって欠かせない知識となっています。ぜひ最後までお読みください！
製造・コーディング(PG/フロントエンド)
【初心者用】Pythonでスクレイピングをしてみよう
前回の記事で、Pythonのプログラムを実行するための環境構築について解説しました。 今回の記事では、Pythonで出来る作業の代表格でもあるスクレイピングを実際に行い、プログラミングのイメージを可視化していければと思います。 前回の記事で構築した、Jupyter Notebookを使っていきます。
製造・コーディング(PG/バックエンド)
【JSTQB(FL)対策】第5章テストマネジメント<5.3テストのモニタリングとコントロール～5.6欠陥マネジメント>
こちらの記事ではJSTQBのシラバスのうち、第5章テストマネジメント分野<5.3テストのモニタリングとコントロール～5.6欠陥マネジメント>における以下の分野の学習内容及び学習してみて私が思ったことについて記載します。
テスト(運用・保守・サポート)
初心者が始めるVue.jsハンズオン
近年JSフレームワークとして人気の高いVue.jsの学習を兼ね、Vue.jsの導入から実装までを実施してみます。・環境DockerWSLnginxVue.js
その他(PG/バックエンド)
【初心者用】プログラミング言語 Javaの概要・特徴など
Most popular technologies - Programming, scripting, and markup languagesJavaは、C言語をベースに開発されたプログラミング言語です。1996年にサン・マイクロシステムズによって市場リリースされました。IT市場を牽引するGoogleが開発に用いる三大言語（Java、C++、Python）の一つとしても知られています。現在200種類以上のプログラミング言語がある中で昔からよく使われており、人気の高いプログラミング言語となっています。
その他(PG/バックエンド)
【初心者用】SQLの書き方・用途などまとめ
SQLはデータベースを操作するための言語です。SQLを使うことでデータベースにデータを挿入したり、検索したりといった操作を効率的に行うことが可能です。本記事ではSQLの基礎構文、用途、サンプルコードをまとめていきます。なお、説明の便宜上、以下の表のデータを使用します。
学習・スキル
HAクラスタリング
CLUSTERPRO1.HAクラスタリングの不可欠性高可用性（High Availability）クラスタリングは、現代のビジネス環境においてシステムの連続性が不可欠です。この技術は、冗長性を確保してシステムの可用性を向上させる手法であり、企業はシステムのダウンタイムを最小限に抑えることで、信頼性の高いサービス提供を実現しています。2.ClusterProの堅牢な歴史ClusterProは、NECが提供する高可用性クラスタリングソリューションで、その信頼性と機能性において業界をリードしてきました。企業は長い歴史を有するClusterProを利用することで、システムの安定性を確保し、ビジネスの運用上の課題に対処しています。3.SecureCube Access CheckのセキュリティフォーカスSecureCube Access Checkは、セキュリティを最優先に考え、企業の情報資産を確実に保護するために開発されました。アクセス管理においてセキュリティの確保は不可欠であり、SecureCube Access Checkはその要請に応えつつ、使いやすさも兼ね備えています。4.SecureCube Access Check × ClusterProの強力な統合SecureCube Access CheckをClusterProでクラスタリングすることで、これら二つの優れた技術が強力に融合します。企業は、高可用性を提供するClusterProとセキュリティ機能を有するSecureCube Access Checkの組み合わせにより、安定性と機密情報の確実な保護を実現できます。
その他(インフラ)
【初心者】JavaScript
JavaScriptとは、動的なWebページを作るためのプログラミング言語の一つです。代表的な機能は、ボタンを押すと画面に別ウィンドウが開く「ポップアップウィンドウ」や、画像が自動送りされる「スライドショー（スライダー）」などの多様なアニメーションです。その他、システムやアプリ開発などのバックエンドでも用いられています。
初心者
関連タグ
カテゴリ別人気記事
もっと見るテレワーク関連人気記事
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でネットワークを学ぶ（NAT）
NATとはNetwork Address Translationの略称でIPアドレスを変換する技術です。 インターネットに接続する際にプライベートIPアドレスをグローバルIPアドレスに変換します。
詳細設計(内部設計)(インフラ)
【初心者向け】Packet Tracerでネットワークを学ぶ（DHCP）
DHCP(Dynamic Host Configuration Protocol)は自動的にIPアドレスやサブネットマスク等をPCやルータに配布してくれるプロトコルです。
詳細設計(内部設計)(インフラ)
【初心者用】ifconfigの出力結果の見方
Linuxシステムでネットワーク設定や情報を確認するための基本的なコマンドの1つがifconfigです。この記事では、初心者向けにifconfigコマンドの使用方法、オプション、出力結果の解釈について詳しく説明します。また、具体的な使用シーンや例、関連するコマンドや技術についても紹介します。
その他(インフラ)