マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い（アップデートされていない） 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
製造・コーディング(PG/バックエンド)
【初心者用】Pythonでスクレイピングをしてみよう
前回の記事で、Pythonのプログラムを実行するための環境構築について解説しました。 今回の記事では、Pythonで出来る作業の代表格でもあるスクレイピングを実際に行い、プログラミングのイメージを可視化していければと思います。 前回の記事で構築した、Jupyter Notebookを使っていきます。
製造・コーディング(PG/バックエンド)
【Android】Fragmentから別FragmentのViewを更新するサンプル【Kotlin】
iOSのアプリ開発とAndroidのアプリ開発の仕組みの大きな違いとしてActivityとFragmentがあります。Androidアプリ開発の際、1つのActivityに対して２つのフラグメントが存在し、FragmentAのクリックイベントを受けてFragmentBの表示を更新する機能を作る機会が有りました。今回はこちらの機能を含んだかんたんなサンプルを作ってみます。LiveDataやDatabindingをある程度理解している初心者向けの記事となります。
製造・コーディング(PG/フロントエンド)
Oracle Service Busの超基礎的な使い方解説
この記事では、Oracle Service Busの基本的な使い方を説明していきます。Oracle Service Busは、エンタープライズ向けのアプリケーション統合プラットフォームであり、メッセージングやWebサービス、ファイルなど様々なプロトコルを統合することができます。
製造・コーディング(PG/バックエンド)
【初心者用】AWS基礎⑦
前回はクラウドプラクティショナーの出題範囲のうちのAWSの主要サービスの識別までを学習してきました。今回はAWSの主要サービスの識別のところについて、さらに学習していきたいと思います。
その他(インフラ)
【SQL 】データベースの正規化について
データの正規化は、必要なデータ項目を整理し、データが重複しないように表を分割することです。データの重複を排除することで、データベース操作に伴う重複更新や矛盾の発生を防ぐことができます。またSQLを使ってデータを取り出す時に、正規化の知識があると何のデータがどこのテーブルに保存されているか感覚的にわかるようになります。
その他(インフラ)
【初心者向け】CCNA基礎 3章
こちらでは、CCNAの資格取得へ向けた情報を記載いたします。
【初心者向け】CCNA基礎 8章
こちらでは、CCNAの資格取得へ向けた情報を記載いたします。
【ソフトウェアテスト】レビューについて
ソフトウェアテスト領域には、動作させることを前提とした対象をテストする動的テストと、動作させることを前提としていない対象をテストする静的テストがあります。単体テストや結合テストなど、作成したものを動作させてテストをするのが動的テストですが、静的テストは動作させる対象がなくてもテストが実施できます。静的テスト活動の種類としてレビューがありますが、開発活動の中で作成された製品やシステム自体以外のものは、レビュー対象としてテストすることが可能です。
テスト(運用・保守・サポート)
【初心者向け】情報セキュリティーについて
情報セキュリティーについて聞いたことがあると思いますが、本記事で改めて学んでいきたいと思います。
関連タグ
カテゴリ別人気記事
もっと見るテレワーク関連人気記事
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など）によっても異なります。インデックスの仕様を知らないと、開発者にとって意図しない処理をしてしまう可能性もあります。そこで今回はインデックスについてメリットデメリットや具体的にどのような種類があるのかを説明していきます。
【初心者用】ASP.NETのサーバーコントロールの種類をまとめてみた～その２～
ASP.NET Webフォームで使われるサーバーコントロールについてまとめてみたので、メモがてら記事にします。 それぞれのサーバーコントロールについて、固有のプロパティ等を具体例を交えてざっくり説明していきます。 （ID等の共通するプロパティは別記事で説明しているため、今回は取り上げません） 今回説明するサーバーコントロールは、以下になります。 ・HyperLink コントロール ・CheckBox コントロール ・RadioButton コントロール サンプルコードの開発環境は、 ・Microsoft Visual Studio Community 2022 実行ブラウザは ・GoogleChrome です。
製造・コーディング(PG/バックエンド)
【初心者向け】Packet Tracerでネットワークを学ぶ（CLI操作の基本編①）
ルータ初期設定編ではPacket Tracerを使ってルータを直接操作し色々な設定を試してみたいと思います。 まずCisco製品のルータにはPCと同様にOSがインストールされています。 それが「Cisco IOS(Internetwork Operating System)」です。 スイッチでもこのOSを利用しています。 Cisco IOSはWindowsのようなグラフィカルなインターフェースではなくコマンド入力のみで様々な操作を行うインターフェースになります。 コマンドで操作するインターフェースのことを「CLI(Command Line Interface）」と言います。
詳細設計(内部設計)(インフラ)