マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い（アップデートされていない） 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
【初心者用】SAP学習3
前回まではSAPの導入部分や具体的な仕事内容、能力について学習をしてきました。今回はABAPプログラムについて学習をしていきます。
【Swift】Cloud FireStoreを使ったサンプルアプリを作ってみる【Firebase】【iOS】
Firebaseでチャットのようなリアルタイム更新が必要なアプリを作るには、Realtime Databaseを使う必要が有ると思っていました。公式のドキュメントを読んでいると、Cloud FirestoreとRealtime Databaseの比較についての記事がありまして、どちらもリアルタイム更新が実現できると記載がありました。簡単に調べた限りだと料金プラン的にもFirestoreを使ったほうがコストを抑えることができるようです。今回はこのCloud Firestoreを使って、リアルタイム更新、データの追加、取得、削除を行うサンプルを作ってみます。環境・MacOS Ventura 13.0・Xcode 14.2・Swift version 5.7.2
製造・コーディング(PG/フロントエンド)
【iOS】初めてのSwiftUI 【Part2】
【iOS】初めてのSwiftUI 【Part1】が長くなりそうだったので、Part2としてこちらに記録します。それではSwiftUIで新規プロジェクトを作成済みの状態から始めていきます。環境・MacOS Ventura 13.0・Xcode 14.2・Swift version 5.7.2
製造・コーディング(PG/フロントエンド)
【パート１】ChatGPTをデスクトップ上から使えるようにデスクトップアプリ化してみた｜Node.js & Electron
最近、ChatGPTという物がとても注目されています。私自身も、実際に使用してみてその性能に驚きました。簡単な質問はもちろん、前提条件を指定した文章の作成や、プログラミングのコード作成までできてしまいます。今回はその便利なChatPGTをデスクトップアプリ化し、どこからでも質問を行えるようにしていきたいと思います。
簡単にオンライン通信を実装できるライブラリ「Socket.io」について調べてみた｜Node.js
リアルタイムWebアプリケーションにおいて、双方向通信は必須です。そのためには、WebSocketというプロトコルが使われますが、Socket.IOというライブラリを使うことで、より簡単にWebSocketを使った双方向通信を実現することができます。この記事では、Socket.IOについて分かりやすく説明していきます。
データ分析に使用されるR言語の基礎構文をまとめてみた
R言語は、統計解析やデータ分析に特化したプログラミング言語であり、初心者でも比較的簡単に学ぶことができます。今回はR言語の初心者向けにR言語の基礎を紹介しようと思います。
Oracle Service Busの超基礎的な使い方解説
この記事では、Oracle Service Busの基本的な使い方を説明していきます。Oracle Service Busは、エンタープライズ向けのアプリケーション統合プラットフォームであり、メッセージングやWebサービス、ファイルなど様々なプロトコルを統合することができます。
関連タグ
カテゴリ別人気記事
もっと見るテレワーク関連人気記事
2023年10月02日
製造・コーディング(PG/フロントエンド)2023年07月18日
2023年10月26日
テスト(運用・保守・サポート)2023年11月17日
2023年01月09日
詳細設計(内部設計)(インフラ)
週間人気記事
もっと見る＃12 SES企業の見極め5選
こんにちは！ラーニンギフト採用担当です。「SESって会社によってかなり違うって聞くけど、何を基準に選べばいいの？」そんな不安を感じているエンジニアの方も多いのではないでしょうか。実際、SES企業は数が多く、働き方やサポート体制も会社によってさまざまです。そのため、"どの会社を選ぶか”によって、エンジニアとしてのキャリアや働きやすさが大きく変わることもあります。今回は、SES企業を選ぶ際に確認しておきたいポイントを5つご紹介します！
プログラマー(バックエンドエンジニア)
#11キャリアサポーターって何してるの？【“案件に入って終わり”じゃない。キャリサポのリアルに密着】
こんにちは！採用担当です😊今回は、当社でエンジニアのキャリア支援を行っている「キャリアサポーター（通称：キャリサポ）」にインタビュー！SES業界では、「案件参画後は放置だった…」 「相談できる人がいなかった…」そんな声を聞くことも少なくありません。では実際に、当社のキャリサポはどんなことをしているのでしょうか？今回は、・面談で何を見ているのか・どんな人が伸びやすいのか・印象に残っている支援事例 など、“キャリア支援のリアル”について聞いてみました✨
プログラマー(バックエンドエンジニア)
イチから学ぶデータベース・SQL（６）
イチから学ぶデータベース・SQL（５）では、サンプルデータベースに登録されているデータのログ解析をしていきました。 今回も前回同様paizaラーニングを参考に、オンラインRPGを題材としてSQLについて学習を進めていきます。
製造・コーディング(インフラ)
【初心者用】Pythonが何なのかメリット・デメリットの面からまとめてみた
エンジニアとしてのキャリアが短く、データベース・SQLについて疎い自分がデータベースとSQLについて基本から学びながら、データベースとは何か、SQLとは何かを分かりやすいように説明していきます。
製造・コーディング(インフラ)
＃09 社員インタビュー【育児もキャリアも、どちらも大切にしたい。フロントエンドエンジニアとして働く、私のリアルな毎日】
こんにちは！今回は、ラーニンギフトで活躍中のフロントエンドエンジニアにインタビュー🎤育児と仕事を両立しながら、自分らしいキャリアを歩んでいる社員のリアルな声をお届けします！「エンジニアとして成長したい」「でも、子どもとの時間も諦めたくない」そんな想いを持っている方に、ぜひ読んでほしい内容です😊
#10営業インタビュー【エンジニアの価値を高める仕事とは？】
― 単価10万円アップを実現したリアルな話 ―こんにちは！採用担当です😊今回は、当社で活躍する営業メンバーにインタビュー🎤 エンジニアと企業をつなぐ“営業のリアル”について、ちょっと深掘りしてみました！
DBのビューとは？メリットデメリットや使用方法についても紹介！
アプリケーション開発にとってデータベースは必須スキルとなっております。データベースの知識がないと、アプリケーション開発に難航することでしょう。しかしデータベースの知識を身に付けるとなると、かなりの勉強量を要します。というのもデータベースオブジェクトには様々な種類があり、一朝一夕では身に付くものではありません。今回は、データベースのビューについてご説明いたします。ビューそのものは必ず覚えてなくてはならないと言うものではありませんが、よく使われます。まずは本記事でビューの基礎知識を身に付けてください。本記事ではメリットデメリットや具体的な使用方法について紹介しております。
Git GUIツールの使い方：初心者向けチュートリアル
Gitとは、分散型バージョン管理システムの1つで、コードやファイルなどの変更履歴を記録し、複数の人で同時に開発を進めるために使われます。Linuxの開発者であるLinus Torvaldsによって開発され、現在は世界中の多くの企業やオープンソースプロジェクトで使用されています。Gitは、ファイルの変更履歴を保存するための「リポジトリ」と呼ばれるデータベースを持ち、このリポジトリに対してコミットと呼ばれる操作で変更履歴を追加していきます。また、ブランチと呼ばれる分岐を作成して、異なるバージョンのコードを管理します。Gitの主な特徴としては、以下のようなものが挙げられます。・ローカルでの高速な動作・分散型であるため、オフラインでも開発ができる・変更履歴を管理しやすく、コードの品質を高めることができる・大規模なプロジェクトでもスケーラブルに対応可能Gitは、コマンドラインツールを使って操作することもできますが、GUIツールを使って操作することもできます。