マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い（アップデートされていない） 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
製造・コーディング(PG/バックエンド)
Pythonで自動化できること6選！単純作業を効率化しよう
さまざまな企業で、DX化が推進されていますが、実際に日々の業務で発生する定常的な作業や単純作業は自動化できていますでしょうか。例えば、次のような作業は、一見単純で簡単に見えますが、実は時間や労力をかなり消費しています。 ・ExcelやWordでデータを整理する ・メールを送る ・ファイルを移動する ・PDFを作成する ・Webサイトから情報を収集するしかし、Pythonというプログラミング言語を使うことで、このような作業を自動化することができます。
【初心者向け】Linuxコマンドについて
Linuxコマンドをご存知でしょうか？エンジニアとして働いていると耳にする事があると思います。本記事ではよく使うLinuxコマンドをまとめていきます。
【初心者向け】CCNA基礎 11章
こちらでは、CCNAの資格取得へ向けた情報を記載いたします。
自宅のWindowsでRuby on Rails ～ Gemを理解する
前回の自宅のwindowsでRuby on Rails（基礎編）では、最も基本的なRailsのWebアプリケーションを作成しました。Railsが非常にスピーディーに、かつ簡潔に開発できるということが分かったのですが、Gemを理解すればもっと複雑なことを簡単に実行できると思います。ということで今回は、新たに新しい機能を実装しつつ、RubyのGemについて学習して行こうと思います。
製造・コーディング(PG/バックエンド)
【初心者用】Vue.jsについて
Vueに関して知識が少ないため、せっかくなので学びなおして理解を深めたいと思いまとめようと思いました。できる限り自分のような初心者でも分かるようにまとめたいと思います。
その他(PG/フロントエンド)
エンジニアが保守運用を学ぶメリット
エンジニアにとって保守運用は、技術的なスキルやキャリアの成長にとって欠かせないものです。保守運用はシステムやアプリケーションの健全性を維持し、顧客やユーザに信頼性の高いサービスを提供する重要なプロセスです。本記事では、エンジニアが保守運用を学ぶことのメリットに焦点を当て、その重要性やキャリアに与える影響について探ります。
自宅のWindowsでRuby on Rails ～ 非同期処理
今回は、Railsでの非同期処理について学習していきます。自宅のWindowsでRuby on Rails ～データベース操作２で途中まで実装していた、仕入帳アプリの続きを実装しながら学習します。
製造・コーディング(PG/バックエンド)
フロントエンドエンジニアの需要と将来性、役立つ資格を解説
フロントエンドエンジニアは、ユーザーが直接触れるウェブサイトやアプリケーションのインターフェースを設計・開発する職業です。フロントエンジニアの仕事は、ユーザビリティ、アクセシビリティ、パフォーマンスなど、ユーザーエクスペリエンスを左右する重要な部分を担います。本記事では、フロントエンドエンジニアの需要、将来性、そして役立つ資格について詳しく説明します。
【パート３】ChatGPTをデスクトップ上から使えるようにデスクトップアプリ化してみた｜Node.js & Electron
前回はデスクトップアプリ化したChatGPTを、ショートカットキーで開ける様にできました。ですが、まだまだターミナルから実行する必要があったり、大文字のPを打とうとすると起動してしまったり、不完全な部分が目立ちますね。今回はそんな部分を改善し、更に実用レベルまで近付けていきたいと思います。
製造・コーディング(PG/バックエンド)
関連タグ
カテゴリ別人気記事
もっと見るテレワーク関連人気記事
2023年10月02日
製造・コーディング(PG/フロントエンド)2023年07月18日
アーキテクト・技術選定(PG/バックエンド)2023年10月26日
テスト(運用・保守・サポート)2023年11月17日
2023年01月09日
詳細設計(内部設計)(インフラ)
週間人気記事
もっと見る【これからJP1に触れる人向け】JP1とは
開発プロジェクトに携わる際にJP1というツールに触れたことはあるだろうか。JP1は開発工程、特にテスト作業においては非常に利便性の高いツールである。この記事ではまだJP1に触れたことがない人向けにJP1の概要やJP1を合う買う際に知っておくべき用語を取り上げる。
テスト(運用・保守・サポート)
DBのビューとは？メリットデメリットや使用方法についても紹介！
アプリケーション開発にとってデータベースは必須スキルとなっております。データベースの知識がないと、アプリケーション開発に難航することでしょう。しかしデータベースの知識を身に付けるとなると、かなりの勉強量を要します。というのもデータベースオブジェクトには様々な種類があり、一朝一夕では身に付くものではありません。今回は、データベースのビューについてご説明いたします。ビューそのものは必ず覚えてなくてはならないと言うものではありませんが、よく使われます。まずは本記事でビューの基礎知識を身に付けてください。本記事ではメリットデメリットや具体的な使用方法について紹介しております。
【初心者用】SQL インデックスとビューについてまとめてみた
参考サイト https://style.potepan.com/articles/25208.html SQLのインデックスとは? 作成、確認、削除方法からメリットまで解説! https://medium-company.com/sql-index/ SQL インデックス(INDEX)を作成・削除する http://dbonline.s25.xrea.com/sqlite/index/index3.html UNIQUEインデックス https://www.sejuku.net/blog/52356 SQL入門 PRIMARY KEY(主キー)制約とは? 追加や削除についても解説 https://style.potepan.com/articles/26878.html SQL 主キー(PRIMARY KEY)制約って何? サンプルコードで基本的な使い方を確認しよう! https://smallit.co.jp/blog/a1015/ BLOG SQLのビューについて https://products.sint.co.jp/siob/blog/view ビューとは? 使い方を解説 https://style.potepan.com/articles/25504.html SQLのビューって何? 基本的な使い方を理解しよう https://cs.wingarc.com/manual/drsum/5.5/ja/UUID-3b6e70a4-5a0d-205e-4b2b-fcb2df959cfd.html ALTER VIEW ビューの定義を変更する
製造・コーディング(SE)
GitHubのReadmeをMarkdown記法で書く
Markdown記法は、プレーンテキストに特定の書式を付けることで、簡単にWebページやドキュメントを作成するための記法です。Markdown記法は、文書の見た目を整えるためのHTMLタグを記述する必要がなく、テキストファイルとしても読み書きが容易であるため、多くの人々によって広く使用されています。
プロジェクト推進・管理(PG/バックエンド)
【初心者向け】Packet Tracerでネットワークを学ぶ（CLI操作の基本編①）
ルータ初期設定編ではPacket Tracerを使ってルータを直接操作し色々な設定を試してみたいと思います。 まずCisco製品のルータにはPCと同様にOSがインストールされています。 それが「Cisco IOS(Internetwork Operating System)」です。 スイッチでもこのOSを利用しています。 Cisco IOSはWindowsのようなグラフィカルなインターフェースではなくコマンド入力のみで様々な操作を行うインターフェースになります。 コマンドで操作するインターフェースのことを「CLI(Command Line Interface）」と言います。
詳細設計(内部設計)(インフラ)
オブジェクト指向プログラミングとは？その特徴と代表的な言語を紹介
プログラミングというと、難しくて理解しにくいものと思われがちですが、実は私たちの身の回りにあるものや現象をモデル化して表現する方法の一つです。プログラミングにはさまざまな種類や手法がありますが、その中でも最も一般的で人気の高いものがオブジェクト指向プログラミングです。では、オブジェクト指向プログラミングとは、どのようなものなのでしょうか？また、どのような特徴やメリットがあるのでしょうか？この記事では、オブジェクト指向プログラミングの基礎と特徴、そして代表的な言語を紹介します。
【HTML】さまざまなタグ | Part 2
今回は、HTMLのさまざまなタグについてまとめました。HTMLは、Web開発をするにあたって欠かせない知識となっています。ぜひ最後までお読みください！
製造・コーディング(PG/フロントエンド)