マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い（アップデートされていない） 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
製造・コーディング(PG/バックエンド)
仕事の流れを可視化する業務フローの作り方
システム開発の現場に参画して一番最初に学ぶ内容が、今回紹介する業務フローです。 前回紹介したマニュアルと近しいドキュメントにはなってしまいますが、マニュアルと業務フローは全く別の観点から作り上げるドキュメントです。 マニュアルは、システムの操作方法などを記したドキュメントなのに対して、業務フローは【仕事の内容や手順を図で表したもの】です。 業務を視覚化することで、見落としを行うリスクが軽減し、文章で手順を読むよりもわかりやすく、全体像を掴みやすくするというメリットがあります。 各現場によっては非常に読みづらい業務フローが整備されていますが、適切に書かれたフローであれば業務の流れを直観的に理解しやすく、業務マニュアルや新人研修としても活用できるため、非常に効果的です。 担当者が業務を改善したり、他部署の業務について相互理解を深めたりするツールとしても有効です。 小規模・中規模のシステムにも活用できますが、大規模なシステムにおいては、全体の機能を業務フローで表すことができるので、保守性の向上にもつなげることができます。 障害が発生して調査をおこなう場合などでも、ソースコードのみを調べると時間がかかりますが、業務フローがあれば、機能ごとのきりわけができるので問題を早く特定しやすくなります。 もちろん、システムの機能拡張や業務内容の変更の際も、業務フローがあれば検討資料としても活用されるシーンが多いです。 業務フロー作成の目的をまとめると、 ・業務の視覚化、標準化 ・業務の問題の発見 ・担当者および他部署間の業務の把握、相互理解 ・業務の保守性、拡張性の向上
製造・コーディング(PG/バックエンド)
【2023年版】Pythonのフレームワーク大解剖！人気のフレームワーク4選
Pythonのフレームワークって何があるの？Pythonのフレームワークにはどんな種類があるの？Pythonのおすすめのフレームワークが知りたい。このような疑問をお持ちの方も多いことでしょう。近年、PythonはAI（人工知能）開発において注目を浴び、その人気は急上昇しています。同時に、Pythonを活用するためのさまざまなフレームワークが登場しており、選択肢の多さに戸惑うこともあるかもしれません。AIやウェブ開発、データ解析など、Pythonの適用範囲は広く、その多様性ゆえにどのフレームワークを選ぶべきか、どれを学ぶべきかを選ぶのは決して簡単なことではありません。しかし、この記事ではそんな悩みを解消するために、Pythonのおすすめフレームワークを目的や用途別に紹介し、選び方のポイントも提供します。つまり、あなたの目標やニーズに合った最適なPythonフレームワークを見つけるお手伝いをさせていただきます。Pythonのフレームワーク選びに迷っている方、どのフレームワークが自分に合っているのか迷走している方、ぜひこの記事を読み進めてください。自分にピッタリのPythonフレームワークが見つかるかもしれません。
学習・スキル
PythonでWebアプリケーションを作成するための備忘録
近年AIやディープラーニングの盛り上がりで注目されているPythonですが、特徴、できること、学習方法、Webアプリケーション構築に適しているのかを調べてみました。
初心者
【Java基礎】Java未経験から習得を目指す 環境構築編
どうも、C++が最も得意なプログラマです。仕事の関係でJavaを扱うことになったのですが、Javaに関しては全くの未経験ですので、今回からJavaについて学んでいこうかと思います。
製造・コーディング(PG/フロントエンド)
JSTQBのシラバスを読む【第二章】
本記事ではJSTQB:Foundation Levelのシラバスを読んでいきます。ISTQBテスト技術者資格制度Foundation Level シラバス 日本語版 Version 2023V4.0.J01：https://jstqb.jp/dl/JSTQB-SyllabusFoundation_VersionV40.J01.pdf
初心者
【JSTQB(FL)対策】第2章ソフトウェア開発ライフサイクル全体を通してのテスト
こちらの記事ではJSTQBのシラバスのうち、第2章ソフトウェア開発ライフサイクル全体を通してのテスト分野における以下の分野の学習内容及び学習してみて私が思ったことについて記載します。
テスト(運用・保守・サポート)
システム開発で行うテスト工程と概要のまとめ
開発するシステムの品質を担保するために開発工程に応じてシステムのテストを行う必要があります。開発工程ごとに行うテストではどのようなものがあるのか、そこではどのようなことを行うのかを説明します。「ウォータフォール型開発」と「アジャイル型開発」の開発手法がありますが、ここでは「ウォータフォール型開発」の手法に絞って説明します。
テスト(SE)
Pythonの基本構文
Python(パイソン)とは、1991年にオランダ人のGuido van Rossum（グイド・ヴァン・ロッサム）氏が開発したプログラミング言語です。アプリケーションの開発、人工知能、データ解析など様々な用途に使用でき、少ないコード量で簡潔に書けるため、読み間違えや書き間違い起こりづらいのが特徴です。文法がシンプルでわかりやすく初心者でも取り掛かり易い言語です。
開発環境関連(PG/バックエンド)
時間と場所に縛られない！リモート勤務に必要なエンジニアのスキルを公開！
コロナ禍でシステム業界以外でもリモート勤務が導入され、新しい働き方のかたちが定着しつつある昨今ですね。しかし客先常駐が基本のSES企業では、セキュリティや仕事の生産性の低下が理由でリモート勤務ができない案件もあります。一方で、大手のSIer企業では、オフィスを解約してフルリモートを導入している企業もあり、一軒家を購入して地方移住したり、自然豊かな場所に移り住んで趣味の時間を楽しむ人がいるのも事実です。SESの働き方に不安を覚えて転職を考えられている方も多いでしょう。本記事ではそのような方に向けて、システム業界で2年以上のリモート勤務を経験する筆者が、リモート勤務のメリット・デメリット、リモート勤務に必要なスキルをご紹介します。
働き方
関連タグ
カテゴリ別人気記事
もっと見るテレワーク関連人気記事
2023年10月02日
製造・コーディング(PG/フロントエンド)2023年07月18日
アーキテクト・技術選定(PG/バックエンド)2023年10月26日
テスト(運用・保守・サポート)2023年11月17日
学習・スキル2023年01月09日
詳細設計(内部設計)(インフラ)
週間人気記事
もっと見る【初心者用】IISについて調べてみた
個人でプログラミングを勉強する際にIISを使用することになったのですが、「IISって具体的には何だっけ？」となったのでまとめてみます。 タイトルにある通り、初心者向けに極力噛み砕いて説明していきます。
製造・コーディング(PG/バックエンド)
Git GUIツールの使い方：初心者向けチュートリアル
Gitとは、分散型バージョン管理システムの1つで、コードやファイルなどの変更履歴を記録し、複数の人で同時に開発を進めるために使われます。Linuxの開発者であるLinus Torvaldsによって開発され、現在は世界中の多くの企業やオープンソースプロジェクトで使用されています。Gitは、ファイルの変更履歴を保存するための「リポジトリ」と呼ばれるデータベースを持ち、このリポジトリに対してコミットと呼ばれる操作で変更履歴を追加していきます。また、ブランチと呼ばれる分岐を作成して、異なるバージョンのコードを管理します。Gitの主な特徴としては、以下のようなものが挙げられます。・ローカルでの高速な動作・分散型であるため、オフラインでも開発ができる・変更履歴を管理しやすく、コードの品質を高めることができる・大規模なプロジェクトでもスケーラブルに対応可能Gitは、コマンドラインツールを使って操作することもできますが、GUIツールを使って操作することもできます。
アーキテクト・技術選定(PG/バックエンド)
【これからJP1に触れる人向け】JP1とは
開発プロジェクトに携わる際にJP1というツールに触れたことはあるだろうか。JP1は開発工程、特にテスト作業においては非常に利便性の高いツールである。この記事ではまだJP1に触れたことがない人向けにJP1の概要やJP1を合う買う際に知っておくべき用語を取り上げる。
テスト(運用・保守・サポート)
インデックスとは？メリットデメリットやインデックスの種類も交えてご紹介
インデックスとは、データベースを扱う際には欠かすことのできない概念となります。インデックスの取り扱いによって、データのアクセス速度が大きく変わります。特に大規模なデータを扱う場合には、取り扱いに気をつけなくてはなりません。インデックスを設定した結果、処理速度が遅くなってしまうことやそもそもインデックスを使用するような実行計画が選択されないこともあるのです。インデックスは、DBMSの種類（例えば、OracleやMySQL、Postgreなど）によっても異なります。インデックスの仕様を知らないと、開発者にとって意図しない処理をしてしまう可能性もあります。そこで今回はインデックスについてメリットデメリットや具体的にどのような種類があるのかを説明していきます。
学習・スキル
JUnitとは何か？初心者向け入門ガイド
Junitは、Java言語用のオープンソースの単体テストフレームワークです。単体テストは、プログラムの各部分が個別に正しく動作するかを確認するために行われます。Junitは、テスト駆動開発（TDD）と呼ばれるアジャイルソフトウェア開発の手法をサポートするために開発されました。Junitは、テストケースの定義、テストの自動実行、テスト結果のアサーション（検証）など、テストに必要な機能を提供します。また、テスト結果のレポーティング機能も備えています。Junitは、プログラマーにとって非常に便利なツールであり、プログラムの品質を向上させるために欠かせないものとなっています。Junitを使用することで、プログラムの変更がもたらす影響をすばやく確認することができます。
テスト(PG/バックエンド)
【初心者向け】Packet Tracerでネットワークを学ぶ（DHCP）
DHCP(Dynamic Host Configuration Protocol)は自動的にIPアドレスやサブネットマスク等をPCやルータに配布してくれるプロトコルです。
詳細設計(内部設計)(インフラ)
組み込み開発とOSの関係は？汎用OSとの違いから将来性まで
組み込み開発とは、家電や自動車、ロボットなどに搭載される制御ソフトウェアを開発することです。組み込み開発には、OS（オペレーティングシステム）という重要なソフトウェアが必要です。OSとは、機器の基本的な動作や管理を行うソフトウェアのことで、組み込み開発では、組み込みOSと呼ばれる特殊なOSを使用します。この記事では、OSとは何か、組み込みOSとは何か？組み込みOSの種類から、その需要と将来性まで解説していきます。
初心者
【初心者用】ifconfigの出力結果の見方
Linuxシステムでネットワーク設定や情報を確認するための基本的なコマンドの1つがifconfigです。この記事では、初心者向けにifconfigコマンドの使用方法、オプション、出力結果の解釈について詳しく説明します。また、具体的な使用シーンや例、関連するコマンドや技術についても紹介します。
その他(インフラ)