マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い（アップデートされていない） 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
【Excel VBAマクロを実行するための初期設定】(３回目)
今回は、VBAを作成後の実行方法について、記載していきたいとおもいます。前回書いたサンプルコードを元に少しづつ実行していきます。
Pythonフレームワーク、Django（ジャンゴ）とは
Django（ジャンゴ）とはPythonのWEBアプリケーションフレームワークの1つであり、昨今人気を集めているフレームワークの1つでもあります。 今回の記事を読むことで分かること ・Djangoで出来ることが分かる ・Djangoの概要が分かる
人気のRubyフレームワークを徹底比較！
Rubyの世界では、フレームワークの選択がプロジェクトの成功に大きな影響を与えます。多様なフレームワークが存在する中で、それぞれの特性を理解し、プロジェクトに最適なものを選ぶことは、時には難しい課題となることでしょう。特に、フリーランスのエンジニアにとっては、求人や案件で特定のフレームワークの経験が求められることが一般的です。これにより、適切なフレームワークの知識とスキルは、より良い機会と高い報酬を引き寄せる要因ともなります。Ruby on Railsは、Rubyのフレームワークとして広く知られていますが、他にも多くの優れたフレームワークが存在します。それぞれのフレームワークは、特定の用途や状況に適しており、その選択はプロジェクトのニーズによって変わります。この記事では、Rubyのフレームワークの概要と、それぞれの特徴を深掘りします。また、現在のトレンドや、各フレームワークの利点と欠点、そしてどのような状況で最適なのかについても詳しく解説します。これにより、あなたのプロジェクトやキャリアに最適なフレームワークの選択を、より簡単に、そして的確に行うことができるでしょう。
Flutterを使ってみよう その５（画面遷移等の制御）
前回の記事の続きです。今回は、画面遷移等の制御周りの知識を深めていきましょう。※ 用例で比較説明したほうがわかりよいため、SwiftUIの用例で比較したいため、SwiftUIで開発したことがあることが前提の記事です環境 ・MacOS Ventura 13.6.3 ・Xcode 15.1 ・VSCode 1.85.1 ・Flutter 3.16.5 ・Dart 3.2.3
製造・コーディング(PG/フロントエンド)
【Spring】便利なアノテーションについて知ろう①
Java開発でフレームワークを使用する際、Springが選ばれることが多いと感じます。Springで特徴的なのはアノテーションという@を使った記載になります。そのアノテーションにはどういったものがあるか、どういった意味になるのかを調べてまとめてみました。
【初心者向け】レビューについて
テスト設計後に開発者を交えたレビュー会を行う事があります。本記事はレビューについてまとめていきます。
【Java】Lombokという便利なライブラリについて学ぼう
皆さんはJavaのライブラリであるLombokについてご存じでしょうか。私は開発業務で使用した経験がありますが、恥ずかしながらどういったライブラリなのか、あまり知らずに使用していました。Lombokとはなにか、メリット・デメリットはなにかをこの記事作成を通して調査し、まとめました。
MongoDBを使用してNext.jsのWebアプリケーションを作成してみた
本記事では、MongoDBを使用したNext.jsのWEBアプリケーションの作成方法について解説します。MongoDBはNoSQLの一つで、柔軟なデータベース設計や高速なデータ処理が可能なため、Webアプリケーションの開発において人気があります。Next.jsはReactのフレームワークであり、サーバーサイドレンダリングをサポートしています。MongoDBとNext.jsを組み合わせることで、高速で柔軟性の高いWebアプリケーションを作成することができます。
自宅のWindowsでRuby on Rails ～ビューデザインの基本
「自宅のWindowsでRuby on Rails ～ Gemを理解する」では、Railsを使って簡単なWebアプリケーションを作成しました。しかし、見た目がかなり殺風景です。今回は、Railsにおけるビューデザインについて学んでいこうと思います。
製造・コーディング(PG/フロントエンド)
AUTOSARについて、まとめてみた
AUTOSAR(オートザー)とは、Automotive Open System Architectureの略称で、車載ソフトウェアの共通化を実現するためのプラットフォームの仕様名称でもあります。
開発環境関連(PG/フロントエンド)
SwiftUIの基礎学習とUIKitとの連携【iOS】
先日SwiftUIに初めて触れてシンプルなコードでUIが実装できることにとても魅力を感じました。SwiftUIについてもっと詳しく調べたくなったので、基礎的なことを組み合わせてどんな事ができるのかもう少し詳しく調べてみたいと思います。環境・MacOS Ventura 13.0・Xcode 14.2・Swift version 5.7.2
製造・コーディング(PG/フロントエンド)
関連タグ
カテゴリ別人気記事
もっと見るテレワーク関連人気記事
-
2023年10月02日
製造・コーディング(PG/フロントエンド) -
2023年07月18日
-
2023年10月26日
テスト(運用・保守・サポート) -
2023年01月09日
詳細設計(内部設計)(インフラ) -
2023年11月17日
週間人気記事
もっと見る【初心者向け】Packet Tracerでネットワークを学ぶ（インストール編）
ネットワークエンジニアとしてCisco社のルータやスイッチの運用業務を遂行するには、 コマンドの知識やどのように機器が通信させているかよく理解しておく必要があります。 またCCNAといったネットワークのベンダー資格でも実際にコマンドを記述するシミュレーション問題が出題されることもあるので、自身のネットワークスキル向上には日頃からコマンド操作に慣れておく必要があります。 知識を定着や操作の慣れには座学だけでなく実際に機器に触れコマンドを入力し結果を確認することが一番なのですが、ルータやスイッチ等のネットワーク機器はいずれも高額であり、中古でもそれなりの値段となるので初心者が自宅に環境を作成することは簡単ではありません。 そこでCisco社のルータやスイッチに簡単に機器の設定、環境の構築、コマンドの投入練習といったことができるアプリケーションが「Packet Tracer」となります。
詳細設計(内部設計)(インフラ)
DBのビューとは？メリットデメリットや使用方法についても紹介！
アプリケーション開発にとってデータベースは必須スキルとなっております。データベースの知識がないと、アプリケーション開発に難航することでしょう。しかしデータベースの知識を身に付けるとなると、かなりの勉強量を要します。というのもデータベースオブジェクトには様々な種類があり、一朝一夕では身に付くものではありません。今回は、データベースのビューについてご説明いたします。ビューそのものは必ず覚えてなくてはならないと言うものではありませんが、よく使われます。まずは本記事でビューの基礎知識を身に付けてください。本記事ではメリットデメリットや具体的な使用方法について紹介しております。
インデックスとは？メリットデメリットやインデックスの種類も交えてご紹介
インデックスとは、データベースを扱う際には欠かすことのできない概念となります。インデックスの取り扱いによって、データのアクセス速度が大きく変わります。特に大規模なデータを扱う場合には、取り扱いに気をつけなくてはなりません。インデックスを設定した結果、処理速度が遅くなってしまうことやそもそもインデックスを使用するような実行計画が選択されないこともあるのです。インデックスは、DBMSの種類（例えば、OracleやMySQL、Postgreなど）によっても異なります。インデックスの仕様を知らないと、開発者にとって意図しない処理をしてしまう可能性もあります。そこで今回はインデックスについてメリットデメリットや具体的にどのような種類があるのかを説明していきます。
【これからJP1に触れる人向け】JP1とは
開発プロジェクトに携わる際にJP1というツールに触れたことはあるだろうか。JP1は開発工程、特にテスト作業においては非常に利便性の高いツールである。この記事ではまだJP1に触れたことがない人向けにJP1の概要やJP1を合う買う際に知っておくべき用語を取り上げる。
テスト(運用・保守・サポート)
【初心者向け】Packet Tracerでネットワークを学ぶ（NAT）
NATとはNetwork Address Translationの略称でIPアドレスを変換する技術です。 インターネットに接続する際にプライベートIPアドレスをグローバルIPアドレスに変換します。
詳細設計(内部設計)(インフラ)
【初心者向け】Packet Tracerでネットワークを学ぶ（CLI操作の基本編①）
ルータ初期設定編ではPacket Tracerを使ってルータを直接操作し色々な設定を試してみたいと思います。 まずCisco製品のルータにはPCと同様にOSがインストールされています。 それが「Cisco IOS(Internetwork Operating System)」です。 スイッチでもこのOSを利用しています。 Cisco IOSはWindowsのようなグラフィカルなインターフェースではなくコマンド入力のみで様々な操作を行うインターフェースになります。 コマンドで操作するインターフェースのことを「CLI(Command Line Interface）」と言います。
詳細設計(内部設計)(インフラ)