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

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

製造・コーディング(PG/バックエンド)

【C# WPF】WPFを理解したいC#初心者の話【アプリ作成編2】

C# WPFについて学んでいく過程を備忘録として残して置きたいと思います。

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

【初心者用】PHPとは

フロントエンド開発の勉強をしていて基本的にはNode.jsを使用していたのですが、次回はPHPを使用してサーバー側の処理を作成しようと考えているので今回まとめようと思います。また、結構PHPを使用している所が多いようなので、知らないよりも知っている方が何かと便利かなと思います。

その他(PG/フロントエンド)

JUnitとは何か？初心者向け入門ガイド

Junitは、Java言語用のオープンソースの単体テストフレームワークです。単体テストは、プログラムの各部分が個別に正しく動作するかを確認するために行われます。Junitは、テスト駆動開発（TDD）と呼ばれるアジャイルソフトウェア開発の手法をサポートするために開発されました。Junitは、テストケースの定義、テストの自動実行、テスト結果のアサーション（検証）など、テストに必要な機能を提供します。また、テスト結果のレポーティング機能も備えています。Junitは、プログラマーにとって非常に便利なツールであり、プログラムの品質を向上させるために欠かせないものとなっています。Junitを使用することで、プログラムの変更がもたらす影響をすばやく確認することができます。

テスト(PG/バックエンド)

【初心者用】Rubyとは

最近RubyのフレームワークであるRuby on railsについて調べていたので、フレームワークの元の言語であるRubyについてまとめたいと思います。元のRubyとフレームワークのRuby on railsとの違いや、どのような開発ができるのか学びたいと思います。

その他(PG/フロントエンド)

【ソフトウェアテスト】ソフトウェアテスト関連で耳にするJSTQBとは何か

JSTQBやJSTQB関連資格について、QAやテストといった役割で業務にあたる方のみならず、ソフトウェア開発現場に就業されている各役割の方々(開発エンジニアやPL/PMの方等)にとっても業務に活用できる部分があると思うので、そもそもJSTQBとは何なのかというところを記載していきます。

テスト(運用・保守・サポート)

【初心者用】Goとは

Goという言語自体は聞いたことはあるのですが、特に何に使用されているのかよくわかっていませんでした。ですので、Goという言語が一体どういった強みがあり、どのような現場で使用されているのか学びたいと思います。

その他(PG/バックエンド)

【初心者向け】テスト観点について

テスト観点（test perspective）とは、「ソフトウェアやシステムをテストする際に、評価すべき特定の側面や機能」を指します。テスト観点は、テストプロセスを計画、設計、実行する際に、目標となる品質要素を明確にすることで、効果的なテストケースを作成し、重要な問題を特定できるようにする役割があります。これは、製品やサービスの品質向上に大きく貢献する重要な要素であると言えます。

【初心者用】VB.Netとは

現在特には使用することがないのですが、様々な案件でVB.Netを使用する所が多いので気になっていました。どのようなことに使用するのか理解していないので、どこでどんな風に利用する言語なのかまとめたいと思います。

その他(PG/バックエンド)

【Spring】便利なアノテーションについて知ろう②

便利なアノテーションについて知りましょう！

【初心者用】COBOLとは

直近でCOBOLの案件に行く可能性があるので、COBOLとはどういうものかまとめようかと思います。COBOLは最新の言語ではありませんが、現在でも金融系などで使用されています。ですので、化石のような言語ではありますが、需要自体はあるようなので改めて学ぼうかなと思います。

その他(PG/バックエンド)

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

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

製造・コーディング(PG/バックエンド)