マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い（アップデートされていない） 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
製造・コーディング(PG/バックエンド)
【Swift】 Firebaseでリアルタイム更新のチャット機能を作ってみる【Realtime Database】
Firebaseにはプッシュ通知の機能や、ユーザー認証、リアルタイムデータベースなど様々な機能があります。今回はFirebaseの最初の製品である「Firebase Real-time Database」を使って簡単かつシンプルなチャットアプリを作りました。環境・MacOS Ventura 13.0・Xcode 14.2・Swift version 5.7.2構成、設定等【Firebase】・プロジェクト名: SampleProject【iOS】・プロジェクト名: SampleFirebase・画面構成:１画面(チャットの画面のみ)
製造・コーディング(インフラ)
【初心者用】VB.Netとは
現在特には使用することがないのですが、様々な案件でVB.Netを使用する所が多いので気になっていました。どのようなことに使用するのか理解していないので、どこでどんな風に利用する言語なのかまとめたいと思います。
その他(PG/バックエンド)
Pythonで自動化できること6選！単純作業を効率化しよう
さまざまな企業で、DX化が推進されていますが、実際に日々の業務で発生する定常的な作業や単純作業は自動化できていますでしょうか。例えば、次のような作業は、一見単純で簡単に見えますが、実は時間や労力をかなり消費しています。 ・ExcelやWordでデータを整理する ・メールを送る ・ファイルを移動する ・PDFを作成する ・Webサイトから情報を収集するしかし、Pythonというプログラミング言語を使うことで、このような作業を自動化することができます。
学習・スキル
イチから学ぶデータベース・SQL（４）
イチから学ぶデータベース・SQL（３）では、SQLの読みやすい書き方や間違いやすいポイントなど、実務でSQLを使っていく上での基本的なことについて学習しました。今回は、前回同様paizaラーニングを参考にし、より深くSQLについて学習していきます。
製造・コーディング(インフラ)
【Java基礎】Java未経験から習得を目指す 基礎知識編2
どうも、C++が最も得意なプログラマです。仕事の関係でJavaを扱うことになったのですが、Javaに関しては全くの未経験ですので、今回からJavaについて学んでいこうかと思います。
製造・コーディング(PG/フロントエンド)
【IT転職】Pythonにはどんな特徴があるの？将来性や年収もまとめて解説します！！
今や多くのプログラミング言語が存在する中、プログラミング未経験でも知っている人がいるほど有名で人気なプログラミング言語の一つに「Python」が存在します。しかし、名前だけは知っているもののどんな言語なのか知らない人も中にはいるかと思います。そこで、今回は人気のあるPythonの特徴や将来性、Pythonエンジニアの年収などを解説していきますので、ぜひ参考にしてくださいね。
学習・スキル
【Excel VBAマクロを実行するための初期設定】(２回目)
前回初期設定を行いましたが、今回も引き続き設定と使い方を書いていきたいと思います。さっそくですが、VBA画面を開いていきましょう。
製造・コーディング(SE)
エンジニアが保守運用を学ぶメリット
エンジニアにとって保守運用は、技術的なスキルやキャリアの成長にとって欠かせないものです。保守運用はシステムやアプリケーションの健全性を維持し、顧客やユーザに信頼性の高いサービスを提供する重要なプロセスです。本記事では、エンジニアが保守運用を学ぶことのメリットに焦点を当て、その重要性やキャリアに与える影響について探ります。
キャリア
関連タグ
カテゴリ別人気記事
もっと見るテレワーク関連人気記事
2023年10月02日
製造・コーディング(PG/フロントエンド)2023年07月18日
アーキテクト・技術選定(PG/バックエンド)2023年11月17日
学習・スキル2023年10月26日
テスト(運用・保守・サポート)2023年01月09日
詳細設計(内部設計)(インフラ)
週間人気記事
もっと見るJava開発に必須のフレームワーク | Spring BootとSpringの違いを徹底解説！
Spring BootとSpringはどちらもJavaのWebアプリケーション開発に使われるフレームワークですが、それぞれに特徴やメリットがあります。この記事では、Spring BootとSpringの歴史や機能、使い方などを比較しながら、それぞれの違いを理解していきましょう。
【これからJP1に触れる人向け】JP1とは
開発プロジェクトに携わる際にJP1というツールに触れたことはあるだろうか。JP1は開発工程、特にテスト作業においては非常に利便性の高いツールである。この記事ではまだJP1に触れたことがない人向けにJP1の概要やJP1を合う買う際に知っておくべき用語を取り上げる。
テスト(運用・保守・サポート)
【初心者向け】不具合報告書の書き方
テストエンジニアは業務内で不具合を見つけた際に不具合報告書を起票することになります。不具合報告書とは、発生した不具合の原因と対策について記載した文書です。社内の関係者への共有はもちろん、取引先に提出することもあるため、正確かつわかりやすく記載する必要があります。
初心者
便利なMyBatisについて知ろう
皆さんはMyBatisについて耳にしたことはありますか。私自身MyBatisを軽く触ったことがある程度でしたが学習コストが少なく、便利なフレームワークだと感じました。今回はその便利なMyBatisについて記事作成を通して、読んだ方が基礎知識を学べていただけたらと考えています。
初心者
Git GUIツールの使い方：初心者向けチュートリアル
Gitとは、分散型バージョン管理システムの1つで、コードやファイルなどの変更履歴を記録し、複数の人で同時に開発を進めるために使われます。Linuxの開発者であるLinus Torvaldsによって開発され、現在は世界中の多くの企業やオープンソースプロジェクトで使用されています。Gitは、ファイルの変更履歴を保存するための「リポジトリ」と呼ばれるデータベースを持ち、このリポジトリに対してコミットと呼ばれる操作で変更履歴を追加していきます。また、ブランチと呼ばれる分岐を作成して、異なるバージョンのコードを管理します。Gitの主な特徴としては、以下のようなものが挙げられます。・ローカルでの高速な動作・分散型であるため、オフラインでも開発ができる・変更履歴を管理しやすく、コードの品質を高めることができる・大規模なプロジェクトでもスケーラブルに対応可能Gitは、コマンドラインツールを使って操作することもできますが、GUIツールを使って操作することもできます。
アーキテクト・技術選定(PG/バックエンド)
ウォーターフォール開発とアジャイル開発の違いとは？メリット・デメリットを解説！
システム開発の世界は、さまざまな開発手法がありますが、中でも「ウォーターフォール開発」と「アジャイル開発」は、その代表的なものとして多くのプロジェクトで取り入れられています。しかし、これらの開発手法を聞いたことはあっても具体的にどのように異なるのか知らない方も多いかと思います。この記事では、ウォーターフォール開発とアジャイル開発の違いを明確にし、それぞれの特徴やメリット・デメリットを詳しく解説します。さらに、最近注目されているハイブリッド開発についても触れていきますので、システム開発の手法を選ぶ選択肢の参考として、ぜひお役立てください。
初心者
DBのビューとは？メリットデメリットや使用方法についても紹介！
アプリケーション開発にとってデータベースは必須スキルとなっております。データベースの知識がないと、アプリケーション開発に難航することでしょう。しかしデータベースの知識を身に付けるとなると、かなりの勉強量を要します。というのもデータベースオブジェクトには様々な種類があり、一朝一夕では身に付くものではありません。今回は、データベースのビューについてご説明いたします。ビューそのものは必ず覚えてなくてはならないと言うものではありませんが、よく使われます。まずは本記事でビューの基礎知識を身に付けてください。本記事ではメリットデメリットや具体的な使用方法について紹介しております。
学習・スキル
ITパスポート試験過去問例2
ITパスポート試験の合格は、情報技術の基礎を理解し、一定のスキルを持つことを証明する素晴らしい手段です。ITパスポート試験に合格するために勉強していきたいと思います。本記事では、ITパスポート試験の過去問をピックアップしていきます。
初心者