マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い（アップデートされていない） 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
製造・コーディング(PG/バックエンド)
【ソフトウェアテスト】ソフトウェア開発とテスト活動について ①
ソフトウェアはほとんどの場合、複数の機能を組み合わせてシステムを構築し、さまざまなシステムをまとめたものを運用する想定で開発プロジェクトが進行します。Webシステム開発、アプリケーション開発、組み込みシステム開発など、開発プロジェクトにもそれぞれ種類はありますが、アプリケーションに付随するWebサービスを展開する場合にWebシステムを開発したり、組み込みシステムと連携するアプリケーションを展開する場合にアプリケーション開発をするなど、複数のサービスやプラットフォームが関連しているのがソフトウェアの現状であり、開発プロジェクトもそれに伴って複雑で多様な関係性の中で進行していきます。このため、何か一つを開発して終わりとなることはほとんどなく、開発プロジェクトの開始・終了・進行中に至るまで、そのほか複数の開発プロジェクトの進行も関連してきます。とはいえ、多くのプロジェクトが相互に関連しながら進行しているとしても、プロジェクト進行の工程という点でいうならば、サービスやシステムの企画と検討に始まり、リリース後の継続的な運用保守から運用の終了に至るまでを一つのサイクルとして、開発プロジェクトは段階を経て進行していくといえます。
テスト(運用・保守・サポート)
【PowerShell】業務効率化
仕事の中で、業務を効率化していきたいと思う人も多いでしょう。業務効率化ができるPowerShell について学習していきたいと思います。コマンドプロンプトやバッチファイルとの違いや、どんな場面で使えるのか確認していきましょう。
テスト(IT事務全般)
【初心者用】Pythonでスクレイピングをしてみよう
前回の記事で、Pythonのプログラムを実行するための環境構築について解説しました。 今回の記事では、Pythonで出来る作業の代表格でもあるスクレイピングを実際に行い、プログラミングのイメージを可視化していければと思います。 前回の記事で構築した、Jupyter Notebookを使っていきます。
製造・コーディング(PG/バックエンド)
【初心者用】Pythonが何なのかメリット・デメリットの面からまとめてみた
タイトル通りですが、Python初心者が勉強してみて感じたことをまとめていきます。 なるべく初心者にもわかりやす～いように専門用語をなるべく省いたり嚙み砕いたりしつつ説明します。
製造・コーディング(PG/バックエンド)
【初心者用】Angularについて
いままでReactのみ調べて開発に使用していたのですが、改めて他のフレームワークについて知りたいと思いまとめたいと思いました。後ほど改めて確認する際に、初心者でも理解できるようにまとめれるようにします。
その他(PG/フロントエンド)
【初心者】基本情報はおすすめ
「基本情報（FE）レベルの知識がある人材がほしい」私が経験半年の駆け出しエンジニアの頃、転職活動の際に言われた言葉です。「学生のうちにITパスポートと基本情報を取っておけば就活で評価される」私が学生（情報理工系、偏差値45ぐらい）の時にとある教授が口酸っぱく言っていました。「ITパスポートも大事だけど取得していてもあまりネタにされない」「未経験のエンジニアは基本情報を取って初めて評価されるみたいな」エンジニアが集う交流会で会った、実務5年以上の先輩が言っていました。この”基本情報”という資格、結構大事だそうです。本記事では、基本情報はおすすめだということを話していきます。
学習・スキル
【ゼロから始めるAI】巷で噂のAIを触ってみたい 第1回
よく話題に挙がる「AI」というものAI（人工知能）は、ChatGPTの登場以来、「会話ができるAIが誕生した！」とSNSやメディアで大きな注目を集めてきました。今では企業が業務に取り入れ始めており、社内チャットに導入したり、テスト工程で画像認識を活用したりと、すでにAIは社会に欠かせない存在となりつつあります。私のエンジニアの友人の中には、「このままではAIに仕事を奪われるかもしれない……」と危機感を抱く人も出てきています。さらに、ゲーム開発の分野でもAIを活用した取り組みが話題になるなど、AIの可能性はどんどん広がっています。とはいえ、世間でこれだけ話題になっていても、「AIって何となく分かるけど、実際の使い方までは分からない……」という人も多いのではないでしょうか。実は、私自身もその一人です。だったらいっそ、自分で触って、理解を深めてみよう！ そう思い立ったのがこの企画の始まりです。AIを趣味や仕事に活かすヒントを探しながら、ゼロからAIについて学んでいきたいと思います。このシリーズでは、「とにかく簡単に始めてみる」をテーマに、AIの基礎から実際の使い方まで、やさしく解説していきます。
初心者
【初心者用】オブジェクト指向におけるカプセル化について
カプセル化とは、オブジェクト指向における考え方の一つです。 オブジェクト指向については、他サイトで色々と説明が為されておりますが、調べるのが億劫な方は、ざっくり「各々の細かい処理を別クラスに分けて部品化し、メインとなるクラスからそれらを呼び出すという考え方」程度には認識しておいてください。 今回は、カプセル化とはどういった考え方か、その具体例を交えて説明していきたいと思います。
製造・コーディング(PG/バックエンド)
関連タグ
カテゴリ別人気記事
もっと見るテレワーク関連人気記事
2023年10月02日
製造・コーディング(PG/フロントエンド)2023年07月18日
アーキテクト・技術選定(PG/バックエンド)2023年10月26日
テスト(運用・保守・サポート)2023年11月17日
学習・スキル2023年01月09日
詳細設計(内部設計)(インフラ)
週間人気記事
もっと見る【これからJP1に触れる人向け】JP1とは
開発プロジェクトに携わる際にJP1というツールに触れたことはあるだろうか。JP1は開発工程、特にテスト作業においては非常に利便性の高いツールである。この記事ではまだJP1に触れたことがない人向けにJP1の概要やJP1を合う買う際に知っておくべき用語を取り上げる。
テスト(運用・保守・サポート)
【ソフトウェアテスト】直交表/ペアワイズ法 ①
本記事では直交表について記載します。さまざまな資料を調べて情報をまとめているうちに、直交表、ペアワイズ、HAYST法はそれぞれ直交表を元に関連しているようだと思ったので、直交表から順を追って記載していこうと思います。しかし、それぞれが個別の手法として確立しており、その手法を使用するシーンも違うことから、記事としては独立させたほうが適切かと思ったので、まずは直交表についてまとめたのち、続いて別の記事でペアワイズ法をまとめていきます。
テスト(運用・保守・サポート)
【初心者必見】Mac環境でEclipseをインストールしてみた
今回現場で想定されるJavaの開発をするにあたり、自身のPC(Mac book Air)にJavaの開発環境を構築したいため、MacでEclipseをインストールしようと思う。 参考サイト Java環境構築(Mac版)Eclipseのインストール https://www.techfun.co.jp/service/magazine/java/mac-eclipse-install.html Mac環境でEclipseのダウンロードからプロジェクト立ち上げまでの手順を徹底解説! https://wk-partners.co.jp/homepage/blog/webservices/eclipse/
開発環境関連(SE)
【初心者向け】Packet Tracerでネットワークを学ぶ（NAT）
NATとはNetwork Address Translationの略称でIPアドレスを変換する技術です。 インターネットに接続する際にプライベートIPアドレスをグローバルIPアドレスに変換します。
詳細設計(内部設計)(インフラ)
【初心者用】Prismaについて
Prismaは、データベース操作するためのORMです。Prismaを使用することで、データベースのスキーマを定義し、型安全なクエリを実行できます。また、Prismaは、Prisma Migrateと呼ばれるマイグレーションツールなどを提供しています。データベースのスキーマ変更に伴うマイグレーションを簡単に行うことができます。具体的には、prismaを使用することで、以下のようなことが可能です。 ・データベースのスキーマ定義 ・データのクエリ ・データの作成、更新、削除 ・データの関連付けPrismaは、Prisma Clientと呼ばれる型安全なクライアントライブラリも提供しています。これにより、SQLクエリを直接記述する必要がなくなります。
初心者
【初心者】MySQLの開発環境をつくろう（Windows）
世界中で利用されているデータベースに、MySQLというものがあります。MySQLは利用者も多く重要なデータベースですが、「MySQLって何？」という人もいると思います。本記事では初心者に向けて、MySQLの特徴・インストール方法を説明します。
初心者
【初心者】基本情報技術者試験とは
ITエンジニアを志す人向けの国家資格として、ITを活用する組織、教育機関から定評のある「基本情報技術者試験（FE）」。優秀なIT人材獲得競争に拍車がかかる今日、FE取得はITエンジニアのキャリアパスのきっかけになるかもしれません。本記事では、「基本情報技術者試験」の試験概要などについてご紹介します。
学習・スキル