マニュアル作成で心がけることとは

皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い（アップデートされていない） 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。

Springを使ったAPIの実装方法

そもそもAPIとは、簡単に言うと他社が作った機能を自社のサービスに簡単に取り入れることができます。 例として、自分が住んでいる地域の天気予報が知りたいときにAPIを利用すると、住んでいる地域の情報を引数として相手に教えてあげると結果として自分の住んでいる地域の天気予報データが取得できたりします。 他にも、運送業者などが荷物発送のタイミングでメッセージアプリのAPIを利用すると荷物の発送通知などが利用者に簡単に伝えることができます。 APIを利用すると自社システムの開発の工数を減らすことができ、API利用可能なサービスはAPIを利用することでスムーズに自社のシステムに取り入れることができます。 ただメリットばかりではなくデメリットもあります。 APIの仕様変更やサービスの停止でシステムがうまく動作しなくなったり、APIを運用しているサーバーで不具合があったときはAPIは利用できず APIを過剰に利用せず自社システムである程度対処できるようにしておくことも大事です。

AWSの仕組みがキーワードベースで理解できるようまとめてみた５

AWSの仕組みがキーワードベースで理解できるようまとめてみました。

その他(インフラ)

【初心者用】Docker（ドッカー）とは？

Dockerは今や当たり前に使われているプラットフォームですが、実務で使用することになったため、今更ながら自分なりに調べてまとめてみました。

自宅のwindowsでRuby on Rails（基礎編）

Ruby on Railsは、Webアプリケーションの開発に特化したフレームワークです。MVCの設計パターンを採用し、ActiveRecordを使ったデータベース操作や、ERBを使ったテンプレートエンジンを提供します。Railsは、ルーティングやアクションの定義、そしてRESTfulなAPIの作成をサポートし、コンベンションオーバーコンフィグレーションの原則を採用しているため、開発者は設定ファイルの作成や細かい設定を行う必要がありません。Railsは、開発者の生産性を向上させるために、多くの便利な機能を提供しています。今回は、私がすでに習得済みのSpring Frameworkと比較しながら、Ruby on Railsを学習していきたいと思います。

自宅のWindowsでRuby on Rails ～ Gemを理解する

前回の自宅のwindowsでRuby on Rails（基礎編）では、最も基本的なRailsのWebアプリケーションを作成しました。Railsが非常にスピーディーに、かつ簡潔に開発できるということが分かったのですが、Gemを理解すればもっと複雑なことを簡単に実行できると思います。ということで今回は、新たに新しい機能を実装しつつ、RubyのGemについて学習して行こうと思います。

システムエンジニアに必要なスキルって？現役のシステムエンジニアが教えます

システム業界で活躍して数年経つと、プログラマーとしてスペシャリストになるのか、システム開発に携わる領域を更に広げてシステムエンジニアになるのか、悩まれる方も多いと思います。本記事では、システムエンジニアを目指す方や、システムエンジニアとしてキャリアを積みマネージャーとしてステップアップしたい方に向けて、現役のシステムエンジニアが必要なスキルを解説します。

JavaScriptの進化と現在の重要性 - Node.jsの役割

はるか昔、インターネットがこの世に広まり始めたころ、私はHTMLを書いていました。そしてjavascriptと出会い、時代とともに様々な変遷を経験してきました。そのたびに思ったことが、「今この技術は必要なのか？」でした。今回は、今すでに広く受け入れられている、Node.jsについて学んでいきたいと思います。

【完全ガイド】初心者必見！プログラミング言語の選び方と人気ランキング

初心者向けのプログラミング言語の選択は、IT業界でのキャリア形成において重要なポイントです。特に、人気のある言語や将来性のある言語を選ぶことに迷っている方にとっては、適切な選択が難しいかもしれません。本記事では、プログラミング言語の選び方や人気ランキング、初心者でも学びやすい言語について紹介し、プログラミング言語の選択に迷っている方の悩みを解決します。さあ、IT業界でのスキルアップを見据えたプログラミング言語の選び方を見ていきましょう。

インデックスとは？メリットデメリットやインデックスの種類も交えてご紹介

インデックスとは、データベースを扱う際には欠かすことのできない概念となります。インデックスの取り扱いによって、データのアクセス速度が大きく変わります。特に大規模なデータを扱う場合には、取り扱いに気をつけなくてはなりません。インデックスを設定した結果、処理速度が遅くなってしまうことやそもそもインデックスを使用するような実行計画が選択されないこともあるのです。インデックスは、DBMSの種類（例えば、OracleやMySQL、Postgreなど）によっても異なります。インデックスの仕様を知らないと、開発者にとって意図しない処理をしてしまう可能性もあります。そこで今回はインデックスについてメリットデメリットや具体的にどのような種類があるのかを説明していきます。

【C++基礎】C++プログラマが学びなおす　その１

C++からしばらく離れていたプログラマですが、これからの業務で触れる可能性が出てきたので、一度初心に立ち返って基礎からおさらいをしていく過程を備忘録として残していきます。

製造・コーディング(PG/フロントエンド)

インフラエンジニアの必須ツール！シェルの活用法とは？

インフラエンジニアにとって、シェルは欠かせないツールです。進化していく様々なTI技術でも利用されており、重要な作業を行うことができます。本記事では、そもそも「シェル」とは何か？インフラエンジニアとシェルの関係について、またその活用方法についても詳しく説明していきます。シェルの基本的な概念から実際の活用例まで、あなたの知識を深めるための情報がここにあります。