マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い（アップデートされていない） 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
製造・コーディング(PG/バックエンド)
仕事の流れを可視化する業務フローの作り方
システム開発の現場に参画して一番最初に学ぶ内容が、今回紹介する業務フローです。 前回紹介したマニュアルと近しいドキュメントにはなってしまいますが、マニュアルと業務フローは全く別の観点から作り上げるドキュメントです。 マニュアルは、システムの操作方法などを記したドキュメントなのに対して、業務フローは【仕事の内容や手順を図で表したもの】です。 業務を視覚化することで、見落としを行うリスクが軽減し、文章で手順を読むよりもわかりやすく、全体像を掴みやすくするというメリットがあります。 各現場によっては非常に読みづらい業務フローが整備されていますが、適切に書かれたフローであれば業務の流れを直観的に理解しやすく、業務マニュアルや新人研修としても活用できるため、非常に効果的です。 担当者が業務を改善したり、他部署の業務について相互理解を深めたりするツールとしても有効です。 小規模・中規模のシステムにも活用できますが、大規模なシステムにおいては、全体の機能を業務フローで表すことができるので、保守性の向上にもつなげることができます。 障害が発生して調査をおこなう場合などでも、ソースコードのみを調べると時間がかかりますが、業務フローがあれば、機能ごとのきりわけができるので問題を早く特定しやすくなります。 もちろん、システムの機能拡張や業務内容の変更の際も、業務フローがあれば検討資料としても活用されるシーンが多いです。 業務フロー作成の目的をまとめると、 ・業務の視覚化、標準化 ・業務の問題の発見 ・担当者および他部署間の業務の把握、相互理解 ・業務の保守性、拡張性の向上
製造・コーディング(PG/バックエンド)
Oracle学習1
私はSQLに関しては、SQLServerでの開発をしてきましたが、いただく案件にOracleでの開発という文言をよく見かけます。そのため、自分の学習を兼ねて気になった記事について学習を深めていこうと思いました。
製造・コーディング(インフラ)
Pythonの基本構文
Python(パイソン)とは、1991年にオランダ人のGuido van Rossum（グイド・ヴァン・ロッサム）氏が開発したプログラミング言語です。アプリケーションの開発、人工知能、データ解析など様々な用途に使用でき、少ないコード量で簡潔に書けるため、読み間違えや書き間違い起こりづらいのが特徴です。文法がシンプルでわかりやすく初心者でも取り掛かり易い言語です。
開発環境関連(PG/バックエンド)
開発用エディタ VSCode
VSCodeとは正式名称は「Visual Studio Code」。Microsoft社が提供している無償のテキストエディタです。多くの言語に対応しており、拡張機能やシンタックスハイライト、デバッグ機能なども用意されている為開発用エディタとして世界中の多くのユーザーから利用されています。この記事の対象者・ プログラミング初心者・ コストをかけず、開発を始めたい方・ 開発時に生産性を上げるたい方・ VSCodeにどんな拡張機能があるのか知りたい方
開発環境関連(PG/バックエンド)
jQueryの基本(セレクター編)
jQueryでは、処理対象の要素をセレクターを利用して指定します。CSSと同じセレクターを利用することができるため、標準のJavaScriptに比べて柔軟に要素を指定できるようになっています。
開発環境関連(PG/フロントエンド)
JQueryの基本（制御構造編）
スクリプトでは記述された処理を続けて行うだけでなく、ある条件をもとに処理を変えたり、処理を繰り返したりできます。スクリプトは、通常。1行目から記述した順に実行されていきますが、特定の条件によってこの流れを制御することで、ユーザーのアクションなどに応じた複雑な処理を記述できるようになります。このようにスクリプトの流れをコントロールする仕組みを「制御構造」といいます。制御構造には「条件分岐」と「ループ」があります。
開発環境関連(PG/フロントエンド)
時間と場所に縛られない！リモート勤務に必要なエンジニアのスキルを公開！
コロナ禍でシステム業界以外でもリモート勤務が導入され、新しい働き方のかたちが定着しつつある昨今ですね。しかし客先常駐が基本のSES企業では、セキュリティや仕事の生産性の低下が理由でリモート勤務ができない案件もあります。一方で、大手のSIer企業では、オフィスを解約してフルリモートを導入している企業もあり、一軒家を購入して地方移住したり、自然豊かな場所に移り住んで趣味の時間を楽しむ人がいるのも事実です。SESの働き方に不安を覚えて転職を考えられている方も多いでしょう。本記事ではそのような方に向けて、システム業界で2年以上のリモート勤務を経験する筆者が、リモート勤務のメリット・デメリット、リモート勤務に必要なスキルをご紹介します。
働き方
自宅のwindowsでRuby on Rails（導入編）
私はこれまで、C言語、Perl、Javaを習得してきました。これらの言語は、それぞれ特定の分野で活躍している優れた言語ですが、私は今、新たにRuby on Railsを習得しようとしています。その理由について、以下に述べたいと思います。
開発計画(インフラ)
関連タグ
カテゴリ別人気記事
もっと見るテレワーク関連人気記事
2023年10月02日
製造・コーディング(PG/フロントエンド)2023年07月18日
アーキテクト・技術選定(PG/バックエンド)2023年11月17日
学習・スキル2023年10月26日
テスト(運用・保守・サポート)2023年01月09日
詳細設計(内部設計)(インフラ)
週間人気記事
もっと見るサーバーOSの種類と特徴を徹底解説！選ぶ際のポイントは？
サーバーとは、インターネットやネットワーク上で様々なサービスを提供するコンピューターのことです。サーバーには、ウェブサイトやメール、データベースなどのサービスを提供するために必要なソフトウェアがインストールされていますが、そのソフトウェアを動かすためには、サーバー用のOS（オペレーティングシステム）が必要です。サーバーOSには、主にwindows系、UNIX系、LINUX系の3つの種類がありますが、それぞれにどのような特徴があるのでしょうか？この記事では、サーバーOSの種類と特徴について徹底解説し、選ぶ際のポイントをお伝えします。
開発環境関連(インフラ)
Salesforce開発に欠かせないApexの役割と学習方法を解説
Salesforceは、世界最大のクラウド型のCRM（顧客管理）システムであり、様々な業務やビジネスに対応したアプリケーションを提供しています。Salesforceのアプリケーションは、カスタマイズや拡張が可能で、自分のニーズに合わせて機能やデザインを変更することができます。そこで活躍するのがSalesforce専用のプログラミング言語である「Apex」です。この記事では、Apexの役割や開発環境、Apexの学習方法について解説しますので、これまでSalesforceの標準機能を使うだけで、100%活用できていなかったエンジニアの方は是非最後まで読み進めてください。
初心者
DBのビューとは？メリットデメリットや使用方法についても紹介！
アプリケーション開発にとってデータベースは必須スキルとなっております。データベースの知識がないと、アプリケーション開発に難航することでしょう。しかしデータベースの知識を身に付けるとなると、かなりの勉強量を要します。というのもデータベースオブジェクトには様々な種類があり、一朝一夕では身に付くものではありません。今回は、データベースのビューについてご説明いたします。ビューそのものは必ず覚えてなくてはならないと言うものではありませんが、よく使われます。まずは本記事でビューの基礎知識を身に付けてください。本記事ではメリットデメリットや具体的な使用方法について紹介しております。
学習・スキル
AUTOSARについて、まとめてみた
AUTOSAR(オートザー)とは、Automotive Open System Architectureの略称で、車載ソフトウェアの共通化を実現するためのプラットフォームの仕様名称でもあります。
開発環境関連(PG/フロントエンド)
IVEC学習①
IT検証技術者認定試験(IVEC)とは、一般社団法人IT検証産業協会(IVIA)が認定するテストエンジニアの資格試験です。特徴はテストの現場における実務を重視していることです。IVECのキャリアクラス(下図参照)ごとに実務力を問う記述式試験を設けており、その合格者(認定者)には実際の現場でも安心して仕事が任せられると、業界でも高い評価を受けています。2024年春期試験より従来の試験レベルを再編し、テスタークラス、デザイナークラス、 アーキテクトクラスにすると共に、新たに、初心者向けのアシスタントクラス、専門家として活躍できる エバンジェリストクラスを新設しました。各クラスの試験の合格者を認定者とし、認定証を発行します。
学習・スキル
【初心者向け】不具合報告書の書き方
テストエンジニアは業務内で不具合を見つけた際に不具合報告書を起票することになります。不具合報告書とは、発生した不具合の原因と対策について記載した文書です。社内の関係者への共有はもちろん、取引先に提出することもあるため、正確かつわかりやすく記載する必要があります。
初心者
便利なMyBatisについて知ろう
皆さんはMyBatisについて耳にしたことはありますか。私自身MyBatisを軽く触ったことがある程度でしたが学習コストが少なく、便利なフレームワークだと感じました。今回はその便利なMyBatisについて記事作成を通して、読んだ方が基礎知識を学べていただけたらと考えています。
初心者