マニュアル作成で心がけることとは

皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い（アップデートされていない） 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。

製造・コーディング(PG/バックエンド)

【初心者必見】Python独学を通し、プログラミング入門についてまとめてみた

とあるきっかけからPythonに関心を持ちまして、手探りですが勉強をしてみました。 まだ入り口に片足踏み込んだ程度ですが、プログラミング初心者にとってはその難しい「一歩」の助けになればと思い、記事にしました。 当記事では、ざっくりと ・使用した教材、感じた利点 ・学習のコツ、簡単に応用力を伸ばしていける工夫 について、書いていきます。 プログラミング学習のコツについても解説していくので、Python初心者に留まらず、プログラミング自体が初めての方にも参考になると思います。 ※注意点！ ・本記事は、あくまで学習方法、コツについての解説です。Pythonって何？　どうコーディングすればいいの？　といった点に触れたものではありません。 ・本記事における学習ラインは、タイトルに「入門編」と書いた通り、変数の概念や条件分岐や繰り返し文といった初歩の初歩までです。機械学習やデータ分析といったディープな部分までを補完しうるものではありません。

製造・コーディング(PG/バックエンド)

イチから学ぶデータベース・SQL（４）

イチから学ぶデータベース・SQL（３）では、SQLの読みやすい書き方や間違いやすいポイントなど、実務でSQLを使っていく上での基本的なことについて学習しました。今回は、前回同様paizaラーニングを参考にし、より深くSQLについて学習していきます。

製造・コーディング(インフラ)

Pythonの基本構文

Python(パイソン)とは、1991年にオランダ人のGuido van Rossum（グイド・ヴァン・ロッサム）氏が開発したプログラミング言語です。アプリケーションの開発、人工知能、データ解析など様々な用途に使用でき、少ないコード量で簡潔に書けるため、読み間違えや書き間違い起こりづらいのが特徴です。文法がシンプルでわかりやすく初心者でも取り掛かり易い言語です。

開発環境関連(PG/バックエンド)

【パート１】ChatGPTをデスクトップ上から使えるようにデスクトップアプリ化してみた｜Node.js & Electron

最近、ChatGPTという物がとても注目されています。私自身も、実際に使用してみてその性能に驚きました。簡単な質問はもちろん、前提条件を指定した文章の作成や、プログラミングのコード作成までできてしまいます。今回はその便利なChatPGTをデスクトップアプリ化し、どこからでも質問を行えるようにしていきたいと思います。

製造・コーディング(PG/バックエンド)

簡単にオンライン通信を実装できるライブラリ「Socket.io」について調べてみた｜Node.js

リアルタイムWebアプリケーションにおいて、双方向通信は必須です。そのためには、WebSocketというプロトコルが使われますが、Socket.IOというライブラリを使うことで、より簡単にWebSocketを使った双方向通信を実現することができます。この記事では、Socket.IOについて分かりやすく説明していきます。

製造・コーディング(PG/バックエンド)

【C# WPF】WPFを理解したいC#初心者の話【オブジェクト指向編2】

C# WPFについて学んでいく過程を備忘録として残して置きたいと思います。

製造・コーディング(PG/フロントエンド)

【初心者用】AWS基礎⑤

前回はクラウドプラクティショナーの出題範囲のうちのテクノロジー分野のデプロイと運用からAWSの主要サービスの識別分野のところを少しだけ学習してきました。今回はAWSの主要サービスの識別の続きから学習していきたいと思います。

その他(インフラ)

【初心者用】React フックについて

React フックとは、Reactのライブラリの一部として導入された機能で、state などの React の機能をクラスを書かずに使えるようになります。React フックを活用すると、簡潔で読みやすいコードを記述できます。

【PowerShell】基礎的な用語から

PowerShellはコマンドプロンプトの強化版ということで、業務のさまざまな場面で活用できます。「get-command」を実行し、コマンドレット一覧を表示させ、そこから活用し業務に生かせるようになりたいです。その前にPowerShellででてくる用語などについて理解しておきたいと思います。

テスト(IT事務全般)

【Excel　VBAマクロを実行するための初期設定】(１回目)

ExcelでVBAマクロを実行する際、事前準備(設定)が必要です。Excelを開いたら、VBAの開き方がわからないというところから始まるとおもいます。VBAを開くだけなら「Alt ＋F11」で開けると思いますが、もっと便利に設定を行って行きたいとおもいます。本画面はWindwos11にて実施したものになります。Windows10とほとんど同じになりますが、画面のハードコピーが少し違う場合があります。また、Excelは2021を使用しておりますが、VBAに関しては開いてしまえば変わらないとおもいます。「ファイル」-「オプション」の場所がバージョンにより、異なる可能性があります。

製造・コーディング(SE)

ファンクション（関数）を使ったデータ操作の基礎

他の言語では取得する結果に対して何かしらの処理を行うファンクション（関数）が用意されています。SQLでも同様にファンクション（関数）が用意されています。そこに絞ってデータの操作について記載していきます。

製造・コーディング(PG/バックエンド)