マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い（アップデートされていない） 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
製造・コーディング(PG/バックエンド)
【初心者用】JavaScriptについて少しかじってまとめてみた
タイトル通り、JavaScriptについて勉強してみて、得た知識を軽くまとめていこうと思います。 初心者用、とある通り、極力専門用語は使わないか、噛み砕いて説明していきます。
製造・コーディング(PG/バックエンド)
【Web技術】基本のまとめ | 初心者向け
Web技術の基礎について、分かりやすくまとめました。今回の内容は、エンジニアとしてステップアップするためにかかせない知識となっています。ぜひ最後までお読みください！
Zabbixとは
「Zabbix」とは、Zabbix社が開発しているサーバー／ネットワーク監視用のオープンソースソフトウェアです。ネットワークサービス、サーバー、アプリケーション、その他のネットワークハードウェアのステータスなど、さまざまなIT機器やサービスを集中監視できます。Zabbixは柔軟な通知メカニズムを備え、すべてのイベントに対して電子メールベースのアラートを設定できます。これによって、サーバーの問題に迅速に対応できます。公式サイトZabbix :: The Enterprise-Class Open Source Network Monitoring Solution
その他(運用・保守・サポート)
イチから学ぶデータベース・SQL（５）
イチから学ぶデータベース・SQL（４）では、サンプルデータベースに保存されているデータを使用してログの解析をし、ユーザーのアクセス数を調べるなどしました。 今回は、前回に引き続きpaizaラーニングを参考にして、サンプルデータベースに登録されているデータからログ解析を行っていきます。
製造・コーディング(インフラ)
CCNA学習＃7未経験の方向け
今回はIPアドレッシングについて、まとめていきたいと思います。IPアドレッシングは、ネットワーク上の機器へのIPのアドレスの割り当てになります。
【初心者】C言語とは
最近言語ごと特徴などについて学びなおしています。様々な言語への理解が進んでいくことにより、今後何かしら開発をする際に必要になる可能性を考え学ぼうと思います。
その他(PG/バックエンド)
Flutterを使ってみよう その１０（入力操作①）
今回は、ボタンやテキスト入力やらの入力操作が必要なウィジェットの実装方法の知識を深めていきたいと思います。環境 ・MacOS Ventura 13.6.3 ・Xcode 15.1 ・VSCode 1.85.1 ・Flutter 3.16.5 ・Dart 3.2.3
製造・コーディング(PG/フロントエンド)
関連タグ
カテゴリ別人気記事
もっと見るテレワーク関連人気記事
-
2023年10月02日
製造・コーディング(PG/フロントエンド) -
2023年07月18日
アーキテクト・技術選定(PG/バックエンド) -
2023年11月17日
学習・スキル -
2023年01月09日
詳細設計(内部設計)(インフラ) -
2022年06月17日
週間人気記事
もっと見るDBのビューとは？メリットデメリットや使用方法についても紹介！
アプリケーション開発にとってデータベースは必須スキルとなっております。データベースの知識がないと、アプリケーション開発に難航することでしょう。しかしデータベースの知識を身に付けるとなると、かなりの勉強量を要します。というのもデータベースオブジェクトには様々な種類があり、一朝一夕では身に付くものではありません。今回は、データベースのビューについてご説明いたします。ビューそのものは必ず覚えてなくてはならないと言うものではありませんが、よく使われます。まずは本記事でビューの基礎知識を身に付けてください。本記事ではメリットデメリットや具体的な使用方法について紹介しております。
学習・スキル
Git GUIツールの使い方：初心者向けチュートリアル
Gitとは、分散型バージョン管理システムの1つで、コードやファイルなどの変更履歴を記録し、複数の人で同時に開発を進めるために使われます。Linuxの開発者であるLinus Torvaldsによって開発され、現在は世界中の多くの企業やオープンソースプロジェクトで使用されています。Gitは、ファイルの変更履歴を保存するための「リポジトリ」と呼ばれるデータベースを持ち、このリポジトリに対してコミットと呼ばれる操作で変更履歴を追加していきます。また、ブランチと呼ばれる分岐を作成して、異なるバージョンのコードを管理します。Gitの主な特徴としては、以下のようなものが挙げられます。・ローカルでの高速な動作・分散型であるため、オフラインでも開発ができる・変更履歴を管理しやすく、コードの品質を高めることができる・大規模なプロジェクトでもスケーラブルに対応可能Gitは、コマンドラインツールを使って操作することもできますが、GUIツールを使って操作することもできます。
アーキテクト・技術選定(PG/バックエンド)
【これからJP1に触れる人向け】JP1とは
開発プロジェクトに携わる際にJP1というツールに触れたことはあるだろうか。JP1は開発工程、特にテスト作業においては非常に利便性の高いツールである。この記事ではまだJP1に触れたことがない人向けにJP1の概要やJP1を合う買う際に知っておくべき用語を取り上げる。
テスト(運用・保守・サポート)
GitHubのReadmeをMarkdown記法で書く
Markdown記法は、プレーンテキストに特定の書式を付けることで、簡単にWebページやドキュメントを作成するための記法です。Markdown記法は、文書の見た目を整えるためのHTMLタグを記述する必要がなく、テキストファイルとしても読み書きが容易であるため、多くの人々によって広く使用されています。
プロジェクト推進・管理(PG/バックエンド)
AADとAADCについて
Azure Active Directory(以下Azure AD)とは、Microsoftが提供するクラウドベースで「認証」と「許可」を一元管理するサービスです。Azure ADで認証を行えば、連携しているシステムにログインなしでアクセスできるようになります。Azureアカウントで、他のクラウドサービスが利用できます。例：Dropbox、Slackなど
インデックスとは？メリットデメリットやインデックスの種類も交えてご紹介
インデックスとは、データベースを扱う際には欠かすことのできない概念となります。インデックスの取り扱いによって、データのアクセス速度が大きく変わります。特に大規模なデータを扱う場合には、取り扱いに気をつけなくてはなりません。インデックスを設定した結果、処理速度が遅くなってしまうことやそもそもインデックスを使用するような実行計画が選択されないこともあるのです。インデックスは、DBMSの種類（例えば、OracleやMySQL、Postgreなど）によっても異なります。インデックスの仕様を知らないと、開発者にとって意図しない処理をしてしまう可能性もあります。そこで今回はインデックスについてメリットデメリットや具体的にどのような種類があるのかを説明していきます。
学習・スキル
【初心者用】ifconfigの出力結果の見方
Linuxシステムでネットワーク設定や情報を確認するための基本的なコマンドの1つがifconfigです。この記事では、初心者向けにifconfigコマンドの使用方法、オプション、出力結果の解釈について詳しく説明します。また、具体的な使用シーンや例、関連するコマンドや技術についても紹介します。
セキュリティエンジニアに必要なスキル | 2年目からのロードマップ
デジタル化が進む現代社会では、個人情報や企業の重要な情報を保護するセキュリティエンジニアの役割が急速に重要視されています。特に日本においては、2020年の「JIPDEC（一般財団法人日本情報経済社会推進協会）」の報告によれば、セキュリティ監査を実施している企業は8割を超え、国内のセキュリティ意識の高さが垣間見えます。この背景には、企業のデジタルトランスフォーメーション（DX）の進展やテレワークの普及などにより、サイバー攻撃の標的となりやすい状況が増え、それに対応するためのセキュリティ対策の強化が求められているためです。しかし、セキュリティエンジニアは他のIT職種と比べて高度な専門知識が求められる職種であり、そのための教育・育成体制もまだ十分に整っていないというのが現状です。セキュリティエンジニアとしてキャリアを進める際は、このような市場の状況を理解し、自身のスキルを高め、資格を取得することで市場価値を高め、多くのチャンスをつかむことが可能になるでしょう。本記事では、セキュリティエンジニアとは何か、キャリアアップするには、どのようなスキルや資格が必要なのか、そして現在の業界の状況と平均年収についても解説します。
学習・スキル