マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い（アップデートされていない） 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
【初心者必見】Python独学を通し、プログラミング入門についてまとめてみた
とあるきっかけからPythonに関心を持ちまして、手探りですが勉強をしてみました。 まだ入り口に片足踏み込んだ程度ですが、プログラミング初心者にとってはその難しい「一歩」の助けになればと思い、記事にしました。 当記事では、ざっくりと ・使用した教材、感じた利点 ・学習のコツ、簡単に応用力を伸ばしていける工夫 について、書いていきます。 プログラミング学習のコツについても解説していくので、Python初心者に留まらず、プログラミング自体が初めての方にも参考になると思います。 ※注意点！ ・本記事は、あくまで学習方法、コツについての解説です。Pythonって何？ どうコーディングすればいいの？ といった点に触れたものではありません。 ・本記事における学習ラインは、タイトルに「入門編」と書いた通り、変数の概念や条件分岐や繰り返し文といった初歩の初歩までです。機械学習やデータ分析といったディープな部分までを補完しうるものではありません。
イチから学ぶデータベース・SQL（７）
イチから学ぶデータベース・SQL（６）では、サンプルデータベースに登録されているデータから合計や平均などの計算をしていきました。 今回も、これまでと同様にpaizaラーニングを参考にし、オンラインRPGを題材としてSQLについて学習していきます。
製造・コーディング(インフラ)
イチから学ぶデータベース・SQL（８）
イチから学ぶデータベース・SQL（７）では、サンプルデータベースに登録されているデータから四則演算を使用して日付に関する計算をしました。 今回も、これまでと同様paizaラーニングを参考に、オンラインRPGを題材としてSQLについて学習していきます。
製造・コーディング(インフラ)
イチから学ぶデータベース・SQL（１０）
イチから学ぶデータベース・SQL（９）では、サブクエリについて学習していきました。 今回も、これまでと同様paizaラーニングを参考に、オンラインRPGを題材としてSQLについて学習していきます。
製造・コーディング(インフラ)
イチから学ぶデータベース・SQL（１１）
イチから学ぶデータベース・SQL（１０）では、CASE式について学習していきました。 今回も、これまでと同様paizaラーニングを参考に、オンラインRPGを題材としてSQLについて学習していきます。
製造・コーディング(インフラ)
【Swift】MVPアーキテクチャの簡単なサンプル【iOS】
今回はModel-View-Presenter[MVP]アーキテクチャのデザインパターンで簡単なサンプルを作成します。ModelではDBやAPIアクセスの処理、Presenterではその他の処理、描画はViewで行う考え方に基づき実装しました。これから作るサンプルではModel内でRealmSwiftを使用します。環境・MacOS Ventura 13.0・Xcode 14.2・Swift version 5.7.2
製造・コーディング(PG/フロントエンド)
自宅のwindowsでRuby on Rails（導入編）
私はこれまで、C言語、Perl、Javaを習得してきました。これらの言語は、それぞれ特定の分野で活躍している優れた言語ですが、私は今、新たにRuby on Railsを習得しようとしています。その理由について、以下に述べたいと思います。
開発計画(インフラ)
関連タグ
カテゴリ別人気記事
もっと見るテレワーク関連人気記事
2023年10月02日
製造・コーディング(PG/フロントエンド)2023年07月18日
2023年10月26日
テスト(運用・保守・サポート)2023年11月17日
2023年01月09日
詳細設計(内部設計)(インフラ)
週間人気記事
もっと見る【パート３】ChatGPTをデスクトップ上から使えるようにデスクトップアプリ化してみた｜Node.js & Electron
前回はデスクトップアプリ化したChatGPTを、ショートカットキーで開ける様にできました。ですが、まだまだターミナルから実行する必要があったり、大文字のPを打とうとすると起動してしまったり、不完全な部分が目立ちますね。今回はそんな部分を改善し、更に実用レベルまで近付けていきたいと思います。
GitHubのReadmeをMarkdown記法で書く
Markdown記法は、プレーンテキストに特定の書式を付けることで、簡単にWebページやドキュメントを作成するための記法です。Markdown記法は、文書の見た目を整えるためのHTMLタグを記述する必要がなく、テキストファイルとしても読み書きが容易であるため、多くの人々によって広く使用されています。
【IT転職】JavaのスキルアップにはJava Silverがおすすめ！資格の概要や取得のメリットを解説します！！
Javaプログラマへの転職やJavaのスキルアップを考え、Java学習に励む方が多いと思いますが、中には具体的に何を目標にするのか悩む方も多いかと思います。そんな方に向けて、本記事ではJavaのスキルを証明することができる資格「Java Silver」を紹介し、Javaスキルアップの目標としてJava Silverがおすすめな理由を解説していきます。ぜひ参考にしてくださいね。
ITパスポート試験過去問例
ITパスポート試験は、数種類ある情報処理技術者試験の中で、もっとも初級の入口にあたる試験です。ちなみにお題目は「ITに携わる人職業人として誰もが共通に備えておくべき基礎的な知識をはかる」というものです。パソコンが広く活用されるようになった現代では、是非ともおさえておきたい基礎知識だといえます。といっても、相変わらずITといえば慣れない人にはチンプンカンプンな横文字専門用語が目白押し。そのためにも試験では、「まず解説書を一冊完読して、用語や計算になれること」が欠かせません。本記事では、初心者向けにITパスポートの特徴や過去問に触れていきたいと思います。
インフラエンジニア向け！Shellスクリプトの種類とその魅力
インフラエンジニアの道を歩み始めたばかりの皆さん、シェルスクリプトという言葉をすでに耳にされたでしょうか。シェルスクリプトは、システムやネットワークの設定、管理、自動化など、インフラの様々なタスクを効率よくこなすための強力なツールです。しかし、その機能や種類について深く知らない方も少なくないでしょう。本記事では、シェルとシェルスクリプトの基本的な概念から、主なシェルの種類（sh系とcsh系）、シェルスクリプトで実現できるタスク、そしてシェルスクリプトの重要性について詳細に解説します。また、シェルスクリプトの学習を通じて、自身の技術力向上やキャリア発展にどう寄与できるかについても触れます。シェルスクリプトの知識が浅い方、さらに深い理解を求めている方、ぜひ本記事を参考にして、スキルのブラッシュアップを図ってください。
【初心者向け】Packet Tracerでネットワークを学ぶ（インストール編）
ネットワークエンジニアとしてCisco社のルータやスイッチの運用業務を遂行するには、 コマンドの知識やどのように機器が通信させているかよく理解しておく必要があります。 またCCNAといったネットワークのベンダー資格でも実際にコマンドを記述するシミュレーション問題が出題されることもあるので、自身のネットワークスキル向上には日頃からコマンド操作に慣れておく必要があります。 知識を定着や操作の慣れには座学だけでなく実際に機器に触れコマンドを入力し結果を確認することが一番なのですが、ルータやスイッチ等のネットワーク機器はいずれも高額であり、中古でもそれなりの値段となるので初心者が自宅に環境を作成することは簡単ではありません。 そこでCisco社のルータやスイッチに簡単に機器の設定、環境の構築、コマンドの投入練習といったことができるアプリケーションが「Packet Tracer」となります。
詳細設計(内部設計)(インフラ)
AADとAADCについて
Azure Active Directory(以下Azure AD)とは、Microsoftが提供するクラウドベースで「認証」と「許可」を一元管理するサービスです。Azure ADで認証を行えば、連携しているシステムにログインなしでアクセスできるようになります。Azureアカウントで、他のクラウドサービスが利用できます。例：Dropbox、Slackなど
その他(インフラ)
【初心者用】ProCとは
今度の案件でデータベースの操作関係で、Pro*Cを使用することになりそうなので今回学んでみようと思います。
【これからJP1に触れる人向け】JP1とは
開発プロジェクトに携わる際にJP1というツールに触れたことはあるだろうか。JP1は開発工程、特にテスト作業においては非常に利便性の高いツールである。この記事ではまだJP1に触れたことがない人向けにJP1の概要やJP1を合う買う際に知っておくべき用語を取り上げる。
テスト(運用・保守・サポート)