マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い（アップデートされていない） 上記の内容はいずれも、マニュアルが風化する原因の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・画面構成:１画面(チャットの画面のみ)
製造・コーディング(インフラ)
【JSTQB(FL)対策】第2章ソフトウェア開発ライフサイクル全体を通してのテスト
こちらの記事ではJSTQBのシラバスのうち、第2章ソフトウェア開発ライフサイクル全体を通してのテスト分野における以下の分野の学習内容及び学習してみて私が思ったことについて記載します。
テスト(運用・保守・サポート)
【C++基礎】C++プログラマが学びなおす その１
C++からしばらく離れていたプログラマですが、これからの業務で触れる可能性が出てきたので、一度初心に立ち返って基礎からおさらいをしていく過程を備忘録として残していきます。
製造・コーディング(PG/フロントエンド)
【初心者用】AWS基礎②
前回は、AWSで知っておくべき用語やよく使われるサービスがどんなのがあるのか学んできました。今回は、AWSの初学者として、どんな内容を理解しておけばいいのか、AWSの入門編としてクラウドプラクティショナーという資格があるように、その内容についても触れながら学んでいきましょう。AWS資格は、AWSに関する専門知識やスキルを証明する資格で、試験対策を通してAWSを効率よく学ぶことができます。
【初心者用】Kotlinについて
前回Javaについてまとめたので、今回はKotlinについてまとめようと思います。Androidアプリ開発で活躍しているとのことで、今後必要になった場合のためしっかりと学んでおきたいと思います。
【初心者用】VB.Netとは
現在特には使用することがないのですが、様々な案件でVB.Netを使用する所が多いので気になっていました。どのようなことに使用するのか理解していないので、どこでどんな風に利用する言語なのかまとめたいと思います。
その他(PG/バックエンド)
【初心者用】SQLのクエリ操作基礎１
次回の案件からSQLを使用することになったので、改めてSQLのクエリ操作について学びなおそうと思います。SQLはテストをするにも開発をするにも、使用することになるので基礎的な部分はしっかりとわかりやすくまとめます。
その他(PG/バックエンド)
【初心者用】SQLのクエリ操作基礎4
タイトル通りですが、SQL初心者がクエリ操作に関して学んだことまとめていきます。操作方法について忘れていることが分からないことが多いので、基礎を学んでいきます。
その他(PG/バックエンド)
【初心者】kintoneとは
kintoneは、独自のアプリを作成することで業務効率を改善するクラウドサービスです。実際に、20000社以上の企業がkintoneを導入し、業務効率改善や売上向上を実現しています。kintoneはノーコード開発が可能で、プログラミングの知識やスキルがなくても、アプリケーションやWebサービスの開発が可能です。開発期間が短いため、ソースコードを書く必要がないです。大幅なスピードアップが可能です。今回はkintoneとはどのようなツールなのか、どのようなサービス内容なのかを紹介します。
その他(その他お役立ち情報)
JUnitとは何か？初心者向け入門ガイド
Junitは、Java言語用のオープンソースの単体テストフレームワークです。単体テストは、プログラムの各部分が個別に正しく動作するかを確認するために行われます。Junitは、テスト駆動開発（TDD）と呼ばれるアジャイルソフトウェア開発の手法をサポートするために開発されました。Junitは、テストケースの定義、テストの自動実行、テスト結果のアサーション（検証）など、テストに必要な機能を提供します。また、テスト結果のレポーティング機能も備えています。Junitは、プログラマーにとって非常に便利なツールであり、プログラムの品質を向上させるために欠かせないものとなっています。Junitを使用することで、プログラムの変更がもたらす影響をすばやく確認することができます。
テスト(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職種と比べて高度な専門知識が求められる職種であり、そのための教育・育成体制もまだ十分に整っていないというのが現状です。セキュリティエンジニアとしてキャリアを進める際は、このような市場の状況を理解し、自身のスキルを高め、資格を取得することで市場価値を高め、多くのチャンスをつかむことが可能になるでしょう。本記事では、セキュリティエンジニアとは何か、キャリアアップするには、どのようなスキルや資格が必要なのか、そして現在の業界の状況と平均年収についても解説します。
学習・スキル