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

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

仕事の流れを可視化する業務フローの作り方

システム開発の現場に参画して一番最初に学ぶ内容が、今回紹介する業務フローです。 前回紹介したマニュアルと近しいドキュメントにはなってしまいますが、マニュアルと業務フローは全く別の観点から作り上げるドキュメントです。 マニュアルは、システムの操作方法などを記したドキュメントなのに対して、業務フローは【仕事の内容や手順を図で表したもの】です。 業務を視覚化することで、見落としを行うリスクが軽減し、文章で手順を読むよりもわかりやすく、全体像を掴みやすくするというメリットがあります。 各現場によっては非常に読みづらい業務フローが整備されていますが、適切に書かれたフローであれば業務の流れを直観的に理解しやすく、業務マニュアルや新人研修としても活用できるため、非常に効果的です。 担当者が業務を改善したり、他部署の業務について相互理解を深めたりするツールとしても有効です。 小規模・中規模のシステムにも活用できますが、大規模なシステムにおいては、全体の機能を業務フローで表すことができるので、保守性の向上にもつなげることができます。 障害が発生して調査をおこなう場合などでも、ソースコードのみを調べると時間がかかりますが、業務フローがあれば、機能ごとのきりわけができるので問題を早く特定しやすくなります。 もちろん、システムの機能拡張や業務内容の変更の際も、業務フローがあれば検討資料としても活用されるシーンが多いです。 業務フロー作成の目的をまとめると、 ・業務の視覚化、標準化 ・業務の問題の発見 ・担当者および他部署間の業務の把握、相互理解 ・業務の保守性、拡張性の向上

Oracle学習1

私はSQLに関しては、SQLServerでの開発をしてきましたが、いただく案件にOracleでの開発という文言をよく見かけます。そのため、自分の学習を兼ねて気になった記事について学習を深めていこうと思いました。

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

【初心者用】SAP学習2

前回まではSAPの歴史や商品の内容について見てきました。今回は導入部分から見ていこうと思います。

Pythonの基本構文

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

jQueryを使用してみよう

jQueryとはJavaScriptライブラリです。jQueryを使うことで、インタラクティブな仕掛けもシンプルに実装出来ます。

開発環境関連(PG/フロントエンド)

開発用エディタ VSCode

VSCodeとは正式名称は「Visual Studio Code」。Microsoft社が提供している無償のテキストエディタです。多くの言語に対応しており、拡張機能やシンタックスハイライト、デバッグ機能なども用意されている為開発用エディタとして世界中の多くのユーザーから利用されています。この記事の対象者・ プログラミング初心者・ コストをかけず、開発を始めたい方・ 開発時に生産性を上げるたい方・ VSCodeにどんな拡張機能があるのか知りたい方

jQueryの基本(セレクター編)

jQueryでは、処理対象の要素をセレクターを利用して指定します。CSSと同じセレクターを利用することができるため、標準のJavaScriptに比べて柔軟に要素を指定できるようになっています。

開発環境関連(PG/フロントエンド)

JQueryの基本（制御構造編）

スクリプトでは記述された処理を続けて行うだけでなく、ある条件をもとに処理を変えたり、処理を繰り返したりできます。スクリプトは、通常。1行目から記述した順に実行されていきますが、特定の条件によってこの流れを制御することで、ユーザーのアクションなどに応じた複雑な処理を記述できるようになります。このようにスクリプトの流れをコントロールする仕組みを「制御構造」といいます。制御構造には「条件分岐」と「ループ」があります。

開発環境関連(PG/フロントエンド)

時間と場所に縛られない！リモート勤務に必要なエンジニアのスキルを公開！

コロナ禍でシステム業界以外でもリモート勤務が導入され、新しい働き方のかたちが定着しつつある昨今ですね。しかし客先常駐が基本のSES企業では、セキュリティや仕事の生産性の低下が理由でリモート勤務ができない案件もあります。一方で、大手のSIer企業では、オフィスを解約してフルリモートを導入している企業もあり、一軒家を購入して地方移住したり、自然豊かな場所に移り住んで趣味の時間を楽しむ人がいるのも事実です。SESの働き方に不安を覚えて転職を考えられている方も多いでしょう。本記事ではそのような方に向けて、システム業界で2年以上のリモート勤務を経験する筆者が、リモート勤務のメリット・デメリット、リモート勤務に必要なスキルをご紹介します。

JQueryの基本（関数・メソッド）

JQueryの基本（関数・メソッド）について

開発環境関連(PG/フロントエンド)

自宅のwindowsでRuby on Rails（導入編）

私はこれまで、C言語、Perl、Javaを習得してきました。これらの言語は、それぞれ特定の分野で活躍している優れた言語ですが、私は今、新たにRuby on Railsを習得しようとしています。その理由について、以下に述べたいと思います。

開発計画(インフラ)