エンジニアとしての文章力
経緯
転職するにあたって、文章を書く機会が増えて絶望しまくったのでメモ代わり、及び追々見返したときに初心にかえる意味で書いてみた。
概要
- 自己紹介(初めての記事なので)
- 設計書の文章について
自己紹介
- 30代後半のシステムエンジニア(2020年時点)
- 民間、官公庁の開発からインフラまで、何でもやる人
- プロジェクトマネージャー(以下、PMとする)の役割も経験あるが、だれもPMの指導してくれないのでPMBOKに沿って我流で挑む。
- 資格を色々持っているが、
IPAの高度情報処理試験に合格していない・・・頑張る(笑)情報処理安全確保支援士合格できた! - 毎回、顔色悪いねと言われる。
設計書の文章について
※経験からメモ書きするものなので、正解ではないことに注意願いたい。
次に挙げることは、どのプロジェクトに参画しても必ずと言っていいほど指摘されることで、仕様の検討に入れないくらい面倒なことだと思う。
- 気をつけなくてはいけないこと
1-1. 「です。ます」「だ。である。」プロジェクトのルールに沿って統一
1-2. 主語抜け
1-3. 5W1H - チェックツール使えばいいんじゃない?
1. 気をつけなくてはいけないこと
■ 1-1.「です。ます」「だ。である。」プロジェクトのルールに沿って統一
文章で「~である。」と書いていたのに途中で「~です。」と混在する文章を書いてしまうときがある。これだと読み手が統一感の無い文章となり、気持ち悪くなる。
なぜ、気持ち悪くなるのか考えて見ようと思う。
そもそも「です。ます」調や「だ。である。」調の使い分けが何なのか?それぞれの使い方があるのかなと思ったので調べてみた。
「です。ます」調は、敬体(敬語)
「だ。である。」調は、常体(口語の文体)
ということがわかった。
つまり、敬語と口語が混ざると違和感を覚えるので、文章でも気持ち悪くなるのだと変に納得した。敬語だった人が途中にちょいちょいタメ語を入れるようなものとした。(笑)
設計書に敬うような文章を書くことはないので、「だ。である。」調に統一するのがいいと思うが、プロジェクトのルールがあればそれに沿ったほうが良いと思う。
■ 1-2.主語抜け
設計書に限らず、課題管理票やメールも含まれるのだが、よく主語がないという言葉を聞くことが多い。
主語・・・文章で述語の主体となる部分
述語・・・文章で動作や状態を示す部分
「お客様の回答待ちです。」
と課題票に書かれたとした場合、何が?なんの?ってなる。
何が?の部分が主語となるので、
「◯◯は、お客様の回答待ちです。」
としないと意味分かんない。
ということが現場では意外と多かった・・・
■ 1-3.5W1H
以外と出来ていない5W1H(5W2Hもあるけども)
いつ(When)
どこで(Where)
だれが(Who)
なにを(What)
なぜ(Why)
どうした(How)
※5W2Hの場合、どのくらい(How much)が追加
2. チェックツール使えばいいんじゃない?
文章を訂正するチェックツールとして、Wordがあれば文章校正機能を使ってある程度訂正できると思うが、プロジェクトによっては、ExcelやPowerPointを使う設計書や資料があり、その都度ツールを使いわけることになるため面倒だ。
最近は、Googleスライドやドキュメントを利用するので、生成AIを補助のチェックツールとして使うのもよいかと。
※便利で完璧なチェックツールを知らないだけかも・・・
最後に
メモ代わりで書いた記事なので、記事そのものの文章力が怪しいと思っている。記事を書いていくことで、文章力を高めていきたいと思っているので、間違いがあったら優しく指摘してもらえるととても嬉しい。頑張ろ。。。
文章力については、まだ書ききれないことがあるので、引き続き書いていこうと思う。※必ずやるとは言っていない。