TYPO


※上記の広告は60日以上更新のないWIKIに表示されています。更新することで広告が下部へ移動します。

誤字脱字とドキュメントの品質

SIer・SEの成果物はプログラム・システムではなく、顧客が理解できるドキュメント。


ドキュメントの誤字脱字を防ぐには?

誤字脱字を直すのは「文書校正」という名前もついており、

人の能力を使用する面倒な作業。…とまずは割り切る。


ドキュメント校正の観点を意識する。(自分のアイディア:未実施)

3回見直しを行うと決め、1回1回で校正シナリオを明確にする。

  • 書き写し漏れはないか?[A41枚 10分]
  • 日本語で意味が通らない箇所は?[A41枚 10分]
  • 誤字脱字、句読点は正しいか[A41枚 10分]

A41枚の見直しに30分かかることになる。


「てにおは」の意識、節の順番統一。

仕様書の日本語は「てにおがは」の順番を統一する。

→日本語の原則、長い節から短い節を守る必要はない。

例えば、手順書等では・・・

(1)を→に→での順番に統一している。


AファイルBフォルダコピーする。

Aファイルエディタ開く。

ボタンクリックする。

CファイルDフォルダコピーする。



(2)順番を統一していない。


BフォルダAファイルコピーする。

Aファイルエディタで開く。

ボタンクリックする。

CファイルDフォルダコピーする。


日本語は「長い修飾語は」文の「前に、短い修飾語は」文の「後に」という原則がある。(本田勝一(2013) 日本語の作文技術)

このため、ここで定義する仕様書文書と呼ぶものは、日本語の文書を無理に整形している。

適度な位置に句点を打ってでも語順を守る様にする。


「しりてが」の使用許可

同様にロジカルな文書において「しりてが」は禁止される。

(『~し、~する』『~であり、~となる』『~となって、~である』『~であるが、~なのだ』等)

しかし、仕様を1文にした方が良い場合、しりてがの使用を許可すべき。