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

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

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

【初心者用】はじめてのC言語3

前回の【初心者用】はじめてのC言語2では、四則演算と条件分岐式if文、if文に使用する演算子について解説を行いました。今回はif文の場合分け処理から解説していければと思います。

【初心者用】SAP学習1

次回参画する際にSAPをつかうということになり、実際にどのような言語や将来性についてこの機会に学習をしていこうと思います。

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

【初心者用】Pythonが何なのかメリット・デメリットの面からまとめてみた

エンジニアとしてのキャリアが短く、データベース・SQLについて疎い自分がデータベースとSQLについて基本から学びながら、データベースとは何か、SQLとは何かを分かりやすいように説明していきます。

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

【初心者向け】情報セキュリティーについて

情報セキュリティーについて聞いたことがあると思いますが、本記事で改めて学んでいきたいと思います。

【初心者用】Pythonでできることについて

現在、最も注目を集めているプログラミング言語の１つといわれているのが、今回紹介する「Python （パイソン）」です。 Pythonの特長としては、人工知能（機械学習や深層学習）などの最先端分野の開発にも使われている一方、プログラムの記述方法が簡単なため、 プログラミングを始めたばかりの初心者の方でも大規模なWebアプリケーション開発が短期間でできることがあげられます。 今回は、そんなPython の魅力について詳しくご紹介します。

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

【SQL入門】エンジニア1年目が知っておくべきSQLの基礎知識

エンジニアとしての1年目を迎えると、SQL（Structured Query Language）というデータベース操作言語に触れる機会が増えます。本記事では、SQL文の基礎から始めて、SELECT、INSERT、UPDATE、DELETEといった基本命令の使い方を解説します。エンジニアキャリアのスタートにふさわしいSQLスキルの習得に役立つ情報を提供します。

ActiveReports学習2

前回までは、ActiveReportsの特徴やレポートの種類について学習しました。今回からは構造について学習していきたいと思います。

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

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

イチから学ぶデータベース・SQL（５）では、サンプルデータベースに登録されているデータのログ解析をしていきました。 今回も前回同様paizaラーニングを参考に、オンラインRPGを題材としてSQLについて学習を進めていきます。

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

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

前回、次回は長いマクロを書くとお話しましたが、その前にマクロを書く中で実施しておくと、便利なコードをお伝えしていきたいとおもいます。その後に少し長いコードも実施していければとおもいます。実施しておくと便利なコードとは、４つの停止マクロです。その４つ停止を事前におこなっておけば、マクロは早く動くようになるので、高速化をするのによく使われます。なぜ、高速化をするかというと、ある程度長い処理を実施した場合、高速化を実施しているとしていないのとでは、実行する時間が全然違うからです。すごく違う時は、１０分で終わるマクロも高速化すると半分以下になったりします。便利なコードなので、初心者の方はスタートから書くようにするといいと思います。

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

マークアップ言語でなにができる？その種類と活用法を紹介！

マークアップ言語とは、文書の構造や見た目を表現するための言語のことで、HTMLやXMLなどが有名です。マークアップ言語は、プログラミング言語とは異なり、命令や計算を行うことはできませんが、文書の意味やレイアウトを定義することができます。この記事では、マークアップ言語の特徴やできること、プログラミング言語との違いなどを紹介しながら、マークアップ言語の種類や用途についても説明していきます。

Junit5でのテストコードの覚書

今日一日はまったので、覚書。Junit5Controller.java@Controllerpublic class Junit5Controller {    @RequestMapping("/Junit5")    public @ResponseBody String greeting() {        return "Hello, World";    }}@SpringBootTest@AutoConfigureMockMvcclass Junit5ControllerTest {    @Autowired    private MockMvc mockMvc;    @Test    public void shouldReturnDefaultMessage() throws Exception {        this.mockMvc.perform(get("/Junit5")).andDo(print())        .andExpect(content().string(containsString("Hello, World")));    }}@WebMvcTestではエラーが出る。

テスト(PG/バックエンド)