マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い（アップデートされていない） 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
製造・コーディング(PG/バックエンド)
自宅のWindowsでRuby on Rails ～ Gemを理解する
前回の自宅のwindowsでRuby on Rails（基礎編）では、最も基本的なRailsのWebアプリケーションを作成しました。Railsが非常にスピーディーに、かつ簡潔に開発できるということが分かったのですが、Gemを理解すればもっと複雑なことを簡単に実行できると思います。ということで今回は、新たに新しい機能を実装しつつ、RubyのGemについて学習して行こうと思います。
製造・コーディング(PG/バックエンド)
【初心者用】Pythonとは
Pythonが有名になってからしっかりと調べたことがなかったため、今回改めてPythonについてまとめたいと思います。最近では人工知能開発や業務用のバッチ開発など、様々な開発現場でPythonは使用されています。今後もAIなどが普及していくにつれて、需要はどんどん増えていくと予想されます。ですので、Pythonがどのような言語で、どのような仕事に対してメリットがあるのか知る必要があるかと思います。
その他(PG/バックエンド)
テストエンジニアについて
IT業界で働く際には、できる限り自分に合った職種で働くことが大切です。そこには多種多様な職種があり、その仕事内容や求められるスキルも様々です。なので、実際に仕事を探す際には、個々の職種の違いが何であるかをしっかりと理解しておくことが必要になります。そこで本記事では、「テストエンジニア」という他のエンジニア職とは少し毛色の変わった職種を紹介したいと思います。
キャリア
【初心者用】CakePHPを学んでいこう⑩（プラグイン）
前回はバッチ処理について、CakePHPでのバッチ処理の作成方法について紹介しました。今回はプラグインとは何か、そしてCakePHPで実際にプラグインを使用する方法をご紹介いたします。
製造・コーディング(PG/バックエンド)
【進化するSwift】特徴と将来性に迫る
SwiftはAppleが開発したプログラミング言語であり、iOS、macOS、iPadOS、watchOS、tvOSなどのAppleの製品開発に広く使用されています。その特徴や将来性を知りたい方のために、Swiftの魅力を紹介します。
学習・スキル
【初心者用】VB.Netとは
現在特には使用することがないのですが、様々な案件でVB.Netを使用する所が多いので気になっていました。どのようなことに使用するのか理解していないので、どこでどんな風に利用する言語なのかまとめたいと思います。
その他(PG/バックエンド)
【ソフトウェアテスト】ソフトウェアテスト関連で耳にするJSTQBとは何か
JSTQBやJSTQB関連資格について、QAやテストといった役割で業務にあたる方のみならず、ソフトウェア開発現場に就業されている各役割の方々(開発エンジニアやPL/PMの方等)にとっても業務に活用できる部分があると思うので、そもそもJSTQBとは何なのかというところを記載していきます。
テスト(運用・保守・サポート)
自宅のwindowsでRuby on Rails（基礎編）
Ruby on Railsは、Webアプリケーションの開発に特化したフレームワークです。MVCの設計パターンを採用し、ActiveRecordを使ったデータベース操作や、ERBを使ったテンプレートエンジンを提供します。Railsは、ルーティングやアクションの定義、そしてRESTfulなAPIの作成をサポートし、コンベンションオーバーコンフィグレーションの原則を採用しているため、開発者は設定ファイルの作成や細かい設定を行う必要がありません。Railsは、開発者の生産性を向上させるために、多くの便利な機能を提供しています。今回は、私がすでに習得済みのSpring Frameworkと比較しながら、Ruby on Railsを学習していきたいと思います。
製造・コーディング(PG/バックエンド)
イチから学ぶデータベース・SQL（３）
前回まではデータベースの基本やSQLの基礎について説明してきました。 今回からは、SQLを実務で使うための基本的なことについて学びながら説明していきます。
製造・コーディング(インフラ)
関連タグ
カテゴリ別人気記事
もっと見るテレワーク関連人気記事
2023年10月02日
製造・コーディング(PG/フロントエンド)2023年07月18日
アーキテクト・技術選定(PG/バックエンド)2023年11月17日
学習・スキル2023年10月26日
テスト(運用・保守・サポート)2023年01月09日
詳細設計(内部設計)(インフラ)
週間人気記事
もっと見る【これからJP1に触れる人向け】JP1とは
開発プロジェクトに携わる際にJP1というツールに触れたことはあるだろうか。JP1は開発工程、特にテスト作業においては非常に利便性の高いツールである。この記事ではまだJP1に触れたことがない人向けにJP1の概要やJP1を合う買う際に知っておくべき用語を取り上げる。
テスト(運用・保守・サポート)
Git GUIツールの使い方：初心者向けチュートリアル
Gitとは、分散型バージョン管理システムの1つで、コードやファイルなどの変更履歴を記録し、複数の人で同時に開発を進めるために使われます。Linuxの開発者であるLinus Torvaldsによって開発され、現在は世界中の多くの企業やオープンソースプロジェクトで使用されています。Gitは、ファイルの変更履歴を保存するための「リポジトリ」と呼ばれるデータベースを持ち、このリポジトリに対してコミットと呼ばれる操作で変更履歴を追加していきます。また、ブランチと呼ばれる分岐を作成して、異なるバージョンのコードを管理します。Gitの主な特徴としては、以下のようなものが挙げられます。・ローカルでの高速な動作・分散型であるため、オフラインでも開発ができる・変更履歴を管理しやすく、コードの品質を高めることができる・大規模なプロジェクトでもスケーラブルに対応可能Gitは、コマンドラインツールを使って操作することもできますが、GUIツールを使って操作することもできます。
アーキテクト・技術選定(PG/バックエンド)
DBのビューとは？メリットデメリットや使用方法についても紹介！
アプリケーション開発にとってデータベースは必須スキルとなっております。データベースの知識がないと、アプリケーション開発に難航することでしょう。しかしデータベースの知識を身に付けるとなると、かなりの勉強量を要します。というのもデータベースオブジェクトには様々な種類があり、一朝一夕では身に付くものではありません。今回は、データベースのビューについてご説明いたします。ビューそのものは必ず覚えてなくてはならないと言うものではありませんが、よく使われます。まずは本記事でビューの基礎知識を身に付けてください。本記事ではメリットデメリットや具体的な使用方法について紹介しております。
学習・スキル
【初心者用】ifconfigの出力結果の見方
Linuxシステムでネットワーク設定や情報を確認するための基本的なコマンドの1つがifconfigです。この記事では、初心者向けにifconfigコマンドの使用方法、オプション、出力結果の解釈について詳しく説明します。また、具体的な使用シーンや例、関連するコマンドや技術についても紹介します。
その他(インフラ)
インデックスとは？メリットデメリットやインデックスの種類も交えてご紹介
インデックスとは、データベースを扱う際には欠かすことのできない概念となります。インデックスの取り扱いによって、データのアクセス速度が大きく変わります。特に大規模なデータを扱う場合には、取り扱いに気をつけなくてはなりません。インデックスを設定した結果、処理速度が遅くなってしまうことやそもそもインデックスを使用するような実行計画が選択されないこともあるのです。インデックスは、DBMSの種類（例えば、OracleやMySQL、Postgreなど）によっても異なります。インデックスの仕様を知らないと、開発者にとって意図しない処理をしてしまう可能性もあります。そこで今回はインデックスについてメリットデメリットや具体的にどのような種類があるのかを説明していきます。
学習・スキル
GitHubのReadmeをMarkdown記法で書く
Markdown記法は、プレーンテキストに特定の書式を付けることで、簡単にWebページやドキュメントを作成するための記法です。Markdown記法は、文書の見た目を整えるためのHTMLタグを記述する必要がなく、テキストファイルとしても読み書きが容易であるため、多くの人々によって広く使用されています。
プロジェクト推進・管理(PG/バックエンド)
【ソフトウェアテスト】直交表/ペアワイズ法 ①
本記事では直交表について記載します。さまざまな資料を調べて情報をまとめているうちに、直交表、ペアワイズ、HAYST法はそれぞれ直交表を元に関連しているようだと思ったので、直交表から順を追って記載していこうと思います。しかし、それぞれが個別の手法として確立しており、その手法を使用するシーンも違うことから、記事としては独立させたほうが適切かと思ったので、まずは直交表についてまとめたのち、続いて別の記事でペアワイズ法をまとめていきます。
テスト(運用・保守・サポート)
【初心者用】Linuxファイルシステムとは何か
【図解】初心者向けファイルシステムの基礎知識〜仕組み, OSとの関係, アクセス権との連携〜Linuxファイルシステムとは、コンピュータ上でデータを格納し、組織化するための仕組みです。ファイルやディレクトリ（フォルダ）などのデータを管理し、アクセスするための基盤となります。異なる種類のファイルシステムが存在し、それぞれ異なる特徴を持っています。
その他(インフラ)