マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い（アップデートされていない） 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
製造・コーディング(PG/バックエンド)
Springを使ったAPIの実装方法
そもそもAPIとは、簡単に言うと他社が作った機能を自社のサービスに簡単に取り入れることができます。 例として、自分が住んでいる地域の天気予報が知りたいときにAPIを利用すると、住んでいる地域の情報を引数として相手に教えてあげると結果として自分の住んでいる地域の天気予報データが取得できたりします。 他にも、運送業者などが荷物発送のタイミングでメッセージアプリのAPIを利用すると荷物の発送通知などが利用者に簡単に伝えることができます。 APIを利用すると自社システムの開発の工数を減らすことができ、API利用可能なサービスはAPIを利用することでスムーズに自社のシステムに取り入れることができます。 ただメリットばかりではなくデメリットもあります。 APIの仕様変更やサービスの停止でシステムがうまく動作しなくなったり、APIを運用しているサーバーで不具合があったときはAPIは利用できず APIを過剰に利用せず自社システムである程度対処できるようにしておくことも大事です。
製造・コーディング(PG/バックエンド)
Springを使ったDBデータ登録画面の作成
今回は画面に入力した値をDBに登録する実装方法を紹介します。 またJavaScriptを使った入力チェックなども行います。
製造・コーディング(PG/バックエンド)
Javaを使ったオセロゲームの作成
今回はJavaでオセロゲームを作成したいと思います。 とりあえず何かゲームを作りたくてお手軽にできそうだったので オセロをコンソール画面を使って作っていきたいと思います。 環境 Eclipse(Version: 2022-09 (4.25.0)) Java17
製造・コーディング(PG/バックエンド)
イチから学ぶデータベース・SQL（９）
イチから学ぶデータベース・SQL（８）では、テキスト検索について学習していきました。 今回も、これまでと同様paizaラーニングを参考に、オンラインRPGを題材としてSQLについて学習していきます。
製造・コーディング(インフラ)
【Swift】画面レイアウトをxibファイルに作成する方法【storyboard】
storyboardファイル内で画面遷移とレイアウトの両方を作成していると、画面数が多くなったり、複雑なレイアウトを作成したりした時にどうしても動作が重くなってしまうことがあります。複数人でで作業をしたり、テストをしたりする際にもストーリーボードに全てが詰まっていると作業がしづらいことも多いと思います。これらの問題を解消するために今回は、・stroyboardファイルにはViewControllerと画面遷移のみ・xibファイルに画面レイアウトを作成するこのような形で画面ごとのレイアウトを別ファイルで作成したサンプルプロジェクトを実装してみます。レイアウトを別ファイルで行うことのメリット・デメリットをまとめると以下のようになります。
製造・コーディング(PG/フロントエンド)
【パート１】ChatGPTをデスクトップ上から使えるようにデスクトップアプリ化してみた｜Node.js & Electron
最近、ChatGPTという物がとても注目されています。私自身も、実際に使用してみてその性能に驚きました。簡単な質問はもちろん、前提条件を指定した文章の作成や、プログラミングのコード作成までできてしまいます。今回はその便利なChatPGTをデスクトップアプリ化し、どこからでも質問を行えるようにしていきたいと思います。
製造・コーディング(PG/バックエンド)
自宅のWindowsでRuby on Rails ～データベース操作１
Webアプリケーションにおいて、データベースは非常に重要な役割を果たしています。多くのWebアプリケーションは、ユーザーからの入力情報を記憶するためにデータベースを利用しています。データベースがなければ、Webアプリケーションは単なるツールにすぎず、ユーザーの利便性を向上させることはできません。また、Webアプリケーションの開発者にとっても、データベースは欠かせない存在です。なぜなら、データベースを利用することで、Webアプリケーションの機能性や安定性を高めることができるからです。この記事では、データベースがWebアプリケーションにおいて果たす役割や、RailsでWebアプリケーションを開発する上でのデータベースの設計や操作について、具体的な例を交えながら解説していきます。
製造・コーディング(PG/バックエンド)
エンジニアの将来性とキャリアアップ、安定性を考える―20～30代のプログラマー向け転職ガイド
就活・転職中の20～30代プログラマー必見！IT業界におけるエンジニアの需要は年々増加し、特に20～30代の若手プログラマーの間では、将来性の高い職種として注目を集めています。プログラミングスクールを卒業しエンジニアとして転職に成功したものの、スキルアップや収入面での安定性に悩んではいませんか？エンジニアとしてのキャリアを安定させるための具体的なアドバイスもご紹介します。そんな中、新卒で営業職に就いたものの、趣味のゲームに携わる仕事をしたいという想いからエンジニアへの転職を決意したAさんのケースがあります。プログラミングスクールを卒業しエンジニアとして転職に成功したAさんですが、現在はスキルアップや収入面の安定性に悩みながら、次のキャリアアップを目指して転職活動を行っています。また、将来的に彼女にプロポーズする計画も持っており、安定した仕事を探していることも考慮しています。そこで、本記事では20～30代の就活・転職中のプログラマー向けに、エンジニアの将来性とキャリアアップ、安定を考えた選択について解説します。Aさんの実体験をもとに、最適なスキルの選び方やキャリアの展望について考察し、さらにエンジニアとしてのキャリアを安定させるための具体的なアドバイスもご紹介します。プログラマーを目指す若者や転職を考えるエンジニアにとって、将来を見据えた選択についてのヒントが満載です！
キャリア
Spring Frameworkの解説とWebアプリケーションの作成
Webアプリケーション開発は、企業の情報システムを支える上で欠かせないものとなっています。その中でも、Java言語を利用したWebアプリケーション開発が注目を集めており、Java言語でWebアプリケーションを開発する場合、Spring Frameworkは必須の技術となります。本記事では、Spring Frameworkの導入からWebアプリケーションの作成方法までを解説します。
製造・コーディング(PG/バックエンド)
データ分析に使用されるR言語の基礎構文をまとめてみた
R言語は、統計解析やデータ分析に特化したプログラミング言語であり、初心者でも比較的簡単に学ぶことができます。今回はR言語の初心者向けにR言語の基礎を紹介しようと思います。
製造・コーディング(PG/バックエンド)
関連タグ
カテゴリ別人気記事
もっと見るテレワーク関連人気記事
2023年10月02日
製造・コーディング(PG/フロントエンド)2023年07月18日
アーキテクト・技術選定(PG/バックエンド)2023年11月17日
学習・スキル2023年10月26日
テスト(運用・保守・サポート)2023年01月09日
詳細設計(内部設計)(インフラ)
週間人気記事
もっと見るGit GUIツールの使い方：初心者向けチュートリアル
Gitとは、分散型バージョン管理システムの1つで、コードやファイルなどの変更履歴を記録し、複数の人で同時に開発を進めるために使われます。Linuxの開発者であるLinus Torvaldsによって開発され、現在は世界中の多くの企業やオープンソースプロジェクトで使用されています。Gitは、ファイルの変更履歴を保存するための「リポジトリ」と呼ばれるデータベースを持ち、このリポジトリに対してコミットと呼ばれる操作で変更履歴を追加していきます。また、ブランチと呼ばれる分岐を作成して、異なるバージョンのコードを管理します。Gitの主な特徴としては、以下のようなものが挙げられます。・ローカルでの高速な動作・分散型であるため、オフラインでも開発ができる・変更履歴を管理しやすく、コードの品質を高めることができる・大規模なプロジェクトでもスケーラブルに対応可能Gitは、コマンドラインツールを使って操作することもできますが、GUIツールを使って操作することもできます。
アーキテクト・技術選定(PG/バックエンド)
【これからJP1に触れる人向け】JP1とは
開発プロジェクトに携わる際にJP1というツールに触れたことはあるだろうか。JP1は開発工程、特にテスト作業においては非常に利便性の高いツールである。この記事ではまだJP1に触れたことがない人向けにJP1の概要やJP1を合う買う際に知っておくべき用語を取り上げる。
テスト(運用・保守・サポート)
DBのビューとは？メリットデメリットや使用方法についても紹介！
アプリケーション開発にとってデータベースは必須スキルとなっております。データベースの知識がないと、アプリケーション開発に難航することでしょう。しかしデータベースの知識を身に付けるとなると、かなりの勉強量を要します。というのもデータベースオブジェクトには様々な種類があり、一朝一夕では身に付くものではありません。今回は、データベースのビューについてご説明いたします。ビューそのものは必ず覚えてなくてはならないと言うものではありませんが、よく使われます。まずは本記事でビューの基礎知識を身に付けてください。本記事ではメリットデメリットや具体的な使用方法について紹介しております。
学習・スキル
インデックスとは？メリットデメリットやインデックスの種類も交えてご紹介
インデックスとは、データベースを扱う際には欠かすことのできない概念となります。インデックスの取り扱いによって、データのアクセス速度が大きく変わります。特に大規模なデータを扱う場合には、取り扱いに気をつけなくてはなりません。インデックスを設定した結果、処理速度が遅くなってしまうことやそもそもインデックスを使用するような実行計画が選択されないこともあるのです。インデックスは、DBMSの種類（例えば、OracleやMySQL、Postgreなど）によっても異なります。インデックスの仕様を知らないと、開発者にとって意図しない処理をしてしまう可能性もあります。そこで今回はインデックスについてメリットデメリットや具体的にどのような種類があるのかを説明していきます。
学習・スキル
GitHubのReadmeをMarkdown記法で書く
Markdown記法は、プレーンテキストに特定の書式を付けることで、簡単にWebページやドキュメントを作成するための記法です。Markdown記法は、文書の見た目を整えるためのHTMLタグを記述する必要がなく、テキストファイルとしても読み書きが容易であるため、多くの人々によって広く使用されています。
プロジェクト推進・管理(PG/バックエンド)
【初心者向け】Packet Tracerでネットワークを学ぶ（NAT）
NATとはNetwork Address Translationの略称でIPアドレスを変換する技術です。 インターネットに接続する際にプライベートIPアドレスをグローバルIPアドレスに変換します。
詳細設計(内部設計)(インフラ)
【初心者向け】Packet Tracerでネットワークを学ぶ（DHCP）
DHCP(Dynamic Host Configuration Protocol)は自動的にIPアドレスやサブネットマスク等をPCやルータに配布してくれるプロトコルです。
詳細設計(内部設計)(インフラ)
【初心者用】ifconfigの出力結果の見方
Linuxシステムでネットワーク設定や情報を確認するための基本的なコマンドの1つがifconfigです。この記事では、初心者向けにifconfigコマンドの使用方法、オプション、出力結果の解釈について詳しく説明します。また、具体的な使用シーンや例、関連するコマンドや技術についても紹介します。
その他(インフラ)