マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い（アップデートされていない） 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
製造・コーディング(PG/バックエンド)
webデザイナーに必要なスキルと仕事内容を徹底解説！
webデザイナーはプログラミング初心者からでも始めやすく、需要も高い人気の職種です。しかし、実際にwebデザイナーを目指すにはどのようなスキルや知識が必要なのでしょうか？また、ノーコードツールでもプログラミングができる時代で、webデザイナーの仕事内容や将来性はどうなるのでしょうか？この記事では、webデザイナーに必要なスキルと仕事内容を徹底解説しますので、これからwebデザイナーを目指す方はぜひ参考にして下さい。
学習・スキル
自宅のWindowsでRuby on Rails ～ ヘルパーメソッド
Railsのヘルパーメソッドには、ビューで使用されるいくつかの有用なメソッドがあります。これらのメソッドは、コントローラーで定義された変数やデータをビューに渡すのに役立ちます。たとえば、link_toメソッドは、リンクを作成するのに役立ちますし、form_forメソッドは、フォームを作成するのに役立ちます。これらのヘルパーメソッドは、Railsの基本的なビューの作成に欠かせません。
製造・コーディング(PG/バックエンド)
【初心者用】ASP.NETについて基礎知識をまとめてみた
ASP.NETが必要になったので、勉強してみて分かったことをざっくりまとめてみます。 筆者がASP.NETに関して初心者から入ったので、分かりやすく噛み砕きながら説明していきたいと思います。
製造・コーディング(PG/バックエンド)
【初心者用】CCNA学習＃2OSI参照モデル
本日は、OSI参照モデルと、物理層について簡単にまとめていきたいと思います。上記の内容も、非常に大切な内容になりますので、しっかりと把握していきましょう。
その他(インフラ)
インフラエンジニア1年目がフロントエンドの転職に必要な知識・スキル
開発に興味があるものの、何を学べばよいのかがわからず、日々のサーバー保守・運用案件に忙殺されているという若手インフラエンジニアの方は多いのではないでしょうか。本記事では、開発にチャレンジするべきか、このままインフラのスキルを磨くか、悩みを抱える方に向けて、フロントエンドエンジニアの仕事内容や必要な知識・スキル、役立つ資格などについて解説しています。
学習・スキル
【Swift】TableViewのカスタムセルの作り方と使い方【TableViewCell】
何かと使用頻度の多いTableView。今回はそのTableViewのに使われるセルのカスタム方法について解説します。カスタムセルの作り方の説明、扱い方の説明などできるだけ細かく説明していますので、iOSのアプリ開発が初心者の方にも参考になると思います。環境・MacOS Ventura 13.0・Xcode 14.2・Swift version 5.7.2
製造・コーディング(PG/フロントエンド)
エンジニアが保守運用を学ぶメリット
エンジニアにとって保守運用は、技術的なスキルやキャリアの成長にとって欠かせないものです。保守運用はシステムやアプリケーションの健全性を維持し、顧客やユーザに信頼性の高いサービスを提供する重要なプロセスです。本記事では、エンジニアが保守運用を学ぶことのメリットに焦点を当て、その重要性やキャリアに与える影響について探ります。
キャリア
【初心者用】CakePHPを学んでいこう⑩（プラグイン）
前回はバッチ処理について、CakePHPでのバッチ処理の作成方法について紹介しました。今回はプラグインとは何か、そしてCakePHPで実際にプラグインを使用する方法をご紹介いたします。
製造・コーディング(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を合う買う際に知っておくべき用語を取り上げる。
テスト(運用・保守・サポート)
インデックスとは？メリットデメリットやインデックスの種類も交えてご紹介
インデックスとは、データベースを扱う際には欠かすことのできない概念となります。インデックスの取り扱いによって、データのアクセス速度が大きく変わります。特に大規模なデータを扱う場合には、取り扱いに気をつけなくてはなりません。インデックスを設定した結果、処理速度が遅くなってしまうことやそもそもインデックスを使用するような実行計画が選択されないこともあるのです。インデックスは、DBMSの種類（例えば、OracleやMySQL、Postgreなど）によっても異なります。インデックスの仕様を知らないと、開発者にとって意図しない処理をしてしまう可能性もあります。そこで今回はインデックスについてメリットデメリットや具体的にどのような種類があるのかを説明していきます。
学習・スキル
ECUとはなにか、まとめてみた
ECUとは、車載ECUにおける「ECU」とは、Electronic Control Unit（エレクトロニックコントロールユニット）の略称で、車両のあらゆるシステムを制御する装置の総称です。主にライトやドア、キーレスエントリーシステムなどの車両のボディに関する分野からブレーキ、エンジン、ステアリングなどの制御、オーディオやナビ、GPSなどの情報に関わる分野などもECUが用いられています。現在市販されている自動車には、およそ100個以上ものECUが搭載されており、さらにはハイブリッド車や電気自動車などの環境に対応した最新の自動車にもECUがなくてはならないものとなっています。自動車に関連するECUという用語は、Engine Control Unit（エンジンコントロールユニット）として捉えられることもあります。エンジンコントロールユニットとは、エンジンにおける運転制御を電子的に行うためのマイクロコンピューターのことです。現在ではエンジン制御だけでなく、自動車のあらゆる分野で役割を担っていることから、総称としてElectronic Control Unit（エレクトロニックコントロールユニット）として扱われています。なお、エンジンコントロールユニットの呼び名であり、自動車技術者協会（SAE）および国際標準化機構（ISO）で定義されているものは、ECM（Engine Control Module）と呼ばれます。車載ECUは、自動車に装備されているあらゆる機器やシステムを制御します。この働きによって、エンジン性能の向上や燃費の低減、排出ガスのクリーン化、運転性（ドライバビリティ）の向上などを目指すのが、ECU搭載の目的です。自動車業界の大きな変革期である今、世界中の各自動車メーカーは自社が誇る最新技術を用いて自動車の環境性能や快適性能、安全性能の向上に力を注いでいます。自動運転技術など、これからの自動車においてさまざまな最新機能の司令塔を担うECUは今後の技術発展において必要不可欠なものになっています。
開発環境関連(PG/フロントエンド)
【初心者向け】不具合報告書の書き方
テストエンジニアは業務内で不具合を見つけた際に不具合報告書を起票することになります。不具合報告書とは、発生した不具合の原因と対策について記載した文書です。社内の関係者への共有はもちろん、取引先に提出することもあるため、正確かつわかりやすく記載する必要があります。
初心者
DBのビューとは？メリットデメリットや使用方法についても紹介！
アプリケーション開発にとってデータベースは必須スキルとなっております。データベースの知識がないと、アプリケーション開発に難航することでしょう。しかしデータベースの知識を身に付けるとなると、かなりの勉強量を要します。というのもデータベースオブジェクトには様々な種類があり、一朝一夕では身に付くものではありません。今回は、データベースのビューについてご説明いたします。ビューそのものは必ず覚えてなくてはならないと言うものではありませんが、よく使われます。まずは本記事でビューの基礎知識を身に付けてください。本記事ではメリットデメリットや具体的な使用方法について紹介しております。
学習・スキル
GitHubのReadmeをMarkdown記法で書く
Markdown記法は、プレーンテキストに特定の書式を付けることで、簡単にWebページやドキュメントを作成するための記法です。Markdown記法は、文書の見た目を整えるためのHTMLタグを記述する必要がなく、テキストファイルとしても読み書きが容易であるため、多くの人々によって広く使用されています。
プロジェクト推進・管理(PG/バックエンド)