マニュアル作成で心がけることとは
皆さんはシステム開発現場のマニュアルや仕様書などのドキュメントに対して、どのようなイメージをお持ちでしょうか。 実際にシステム開発の現場で整備されていたマニュアルが、めちゃくちゃ役に立ったと考えているかたは、ごく少数なのではないでしょうか。 各プロジェクトで、エンジニアの入れ替わりが当たり前になった昨今では、業務マニュアルやシステムの操作マニュアルがない会社はないと言っても過言ではありません。 ・分厚くて読む気がしない ・どこに何が書いてあるのか分かりにくい ・そもそも読んでも理解できない ・プロセスやトラブルの解決策が抜けがち ・書いてある内容が古い（アップデートされていない） 上記の内容はいずれも、マニュアルが風化する原因の1つです。 裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目とも考えることが出来ます。 実際、多くのシステム開発の現場で、マニュアルと実際に稼働しているシステムとの情報が乖離しており、マニュアルはストレージを圧迫する邪魔な存在。だと認識されているケースが多いです。 今回の記事では、システムの操作マニュアルに関して、みなさんが実際にマニュアルを作成する場合に、分かりやすく使いやすいマニュアルを作るために心がけるべき5つのポイントについて解説していこうと思います。
製造・コーディング(PG/バックエンド)
【初心者目線】Webアプリケーションの開発 第2回
Webアプリケーションの開発 第2回について書いていきます。
【初心者用】React Nativeについて
Reactは学んでいたのですが、主にWeb系のUI開発にしか使用ができないため、Android開発をしたい場合はできませんでした。ですが、Reactには携帯用のアプリ開発言語があることを知ったので、改めて今回勉強の為にまとめておきたいと思います。
その他(PG/フロントエンド)
Pythonの基本構文
Python(パイソン)とは、1991年にオランダ人のGuido van Rossum（グイド・ヴァン・ロッサム）氏が開発したプログラミング言語です。アプリケーションの開発、人工知能、データ解析など様々な用途に使用でき、少ないコード量で簡潔に書けるため、読み間違えや書き間違い起こりづらいのが特徴です。文法がシンプルでわかりやすく初心者でも取り掛かり易い言語です。
開発環境関連(PG/バックエンド)
【基本】AWSの使い方とその他
みなさんAWSを知っていますか。AWSは今どこの現場でも使われており、任天堂やフジテレビなどアプリではInstagramや漫画アプリなどでも大きく関連しており、今、AWSがないとほとんどのアプリに影響があるほど私たちの生活では必須になっております。そんなAWSについて今回はまとめました。
sts4+JUnit5+Selenium4+Chromeを使ってみる
Seleniumをつかうと、結合テストを自動化した上にスクショまで取ってくれるということでしたが、前回はうまくいきませんでした。そこで今回は、Selenium4でリベンジしたいと思います。
テスト(PG/バックエンド)
【初心者用】Kotlinについて
前回Javaについてまとめたので、今回はKotlinについてまとめようと思います。Androidアプリ開発で活躍しているとのことで、今後必要になった場合のためしっかりと学んでおきたいと思います。
その他(PG/フロントエンド)
【初心者用】SQLのクエリ操作基礎4
タイトル通りですが、SQL初心者がクエリ操作に関して学んだことまとめていきます。操作方法について忘れていることが分からないことが多いので、基礎を学んでいきます。
その他(PG/バックエンド)
ローコードについて(kintone)
近年、IT人材不足やクラウド技術の普及、環境の多様化などの理由から、プログラミングの知識がなくても画面や機能が作成できるローコード開発が注目されています。そこで、今回はローコード開発とローコード開発で代表的なkintoneを実際に使用してみて便利だと思った機能についての記事を作成します。
AADとAADCについて
Azure Active Directory(以下Azure AD)とは、Microsoftが提供するクラウドベースで「認証」と「許可」を一元管理するサービスです。Azure ADで認証を行えば、連携しているシステムにログインなしでアクセスできるようになります。Azureアカウントで、他のクラウドサービスが利用できます。例：Dropbox、Slackなど
その他(インフラ)
【PowerShell】業務効率化
仕事の中で、業務を効率化していきたいと思う人も多いでしょう。業務効率化ができるPowerShell について学習していきたいと思います。コマンドプロンプトやバッチファイルとの違いや、どんな場面で使えるのか確認していきましょう。
テスト(IT事務全般)
関連タグ
カテゴリ別人気記事
もっと見るテレワーク関連人気記事
2023年10月02日
製造・コーディング(PG/フロントエンド)2023年07月18日
アーキテクト・技術選定(PG/バックエンド)2023年11月17日
学習・スキル2023年10月26日
2023年01月09日
詳細設計(内部設計)(インフラ)
週間人気記事
もっと見るGit GUIツールの使い方：初心者向けチュートリアル
Gitとは、分散型バージョン管理システムの1つで、コードやファイルなどの変更履歴を記録し、複数の人で同時に開発を進めるために使われます。Linuxの開発者であるLinus Torvaldsによって開発され、現在は世界中の多くの企業やオープンソースプロジェクトで使用されています。Gitは、ファイルの変更履歴を保存するための「リポジトリ」と呼ばれるデータベースを持ち、このリポジトリに対してコミットと呼ばれる操作で変更履歴を追加していきます。また、ブランチと呼ばれる分岐を作成して、異なるバージョンのコードを管理します。Gitの主な特徴としては、以下のようなものが挙げられます。・ローカルでの高速な動作・分散型であるため、オフラインでも開発ができる・変更履歴を管理しやすく、コードの品質を高めることができる・大規模なプロジェクトでもスケーラブルに対応可能Gitは、コマンドラインツールを使って操作することもできますが、GUIツールを使って操作することもできます。
アーキテクト・技術選定(PG/バックエンド)
DBのビューとは？メリットデメリットや使用方法についても紹介！
アプリケーション開発にとってデータベースは必須スキルとなっております。データベースの知識がないと、アプリケーション開発に難航することでしょう。しかしデータベースの知識を身に付けるとなると、かなりの勉強量を要します。というのもデータベースオブジェクトには様々な種類があり、一朝一夕では身に付くものではありません。今回は、データベースのビューについてご説明いたします。ビューそのものは必ず覚えてなくてはならないと言うものではありませんが、よく使われます。まずは本記事でビューの基礎知識を身に付けてください。本記事ではメリットデメリットや具体的な使用方法について紹介しております。
学習・スキル
【これからJP1に触れる人向け】JP1とは
開発プロジェクトに携わる際にJP1というツールに触れたことはあるだろうか。JP1は開発工程、特にテスト作業においては非常に利便性の高いツールである。この記事ではまだJP1に触れたことがない人向けにJP1の概要やJP1を合う買う際に知っておくべき用語を取り上げる。
インデックスとは？メリットデメリットやインデックスの種類も交えてご紹介
インデックスとは、データベースを扱う際には欠かすことのできない概念となります。インデックスの取り扱いによって、データのアクセス速度が大きく変わります。特に大規模なデータを扱う場合には、取り扱いに気をつけなくてはなりません。インデックスを設定した結果、処理速度が遅くなってしまうことやそもそもインデックスを使用するような実行計画が選択されないこともあるのです。インデックスは、DBMSの種類（例えば、OracleやMySQL、Postgreなど）によっても異なります。インデックスの仕様を知らないと、開発者にとって意図しない処理をしてしまう可能性もあります。そこで今回はインデックスについてメリットデメリットや具体的にどのような種類があるのかを説明していきます。
学習・スキル
GitHubのReadmeをMarkdown記法で書く
Markdown記法は、プレーンテキストに特定の書式を付けることで、簡単にWebページやドキュメントを作成するための記法です。Markdown記法は、文書の見た目を整えるためのHTMLタグを記述する必要がなく、テキストファイルとしても読み書きが容易であるため、多くの人々によって広く使用されています。
プロジェクト推進・管理(PG/バックエンド)
【初心者向け】Packet Tracerでネットワークを学ぶ（NAT）
NATとはNetwork Address Translationの略称でIPアドレスを変換する技術です。 インターネットに接続する際にプライベートIPアドレスをグローバルIPアドレスに変換します。
詳細設計(内部設計)(インフラ)
【初心者用】ASP.NETのサーバーコントロールの種類をまとめてみた～ボタン系編～
ASP.NET Webフォームで使われるサーバーコントロールについてまとめてみたので、メモがてら記事にします。 それぞれのサーバーコントロールについて、固有のプロパティ等を具体例を交えてざっくり説明していきます。 （ID等の共通するプロパティは別記事で説明しているため、今回は取り上げません） 今回説明するサーバーコントロールは、以下になります。 ・Button コントロール ・LinkButton コントロール ・ImageButton コントロール サンプルコードの開発環境は、 ・Microsoft Visual Studio Community 2022 実行ブラウザは ・GoogleChrome です。
製造・コーディング(PG/バックエンド)