ドキュメント作成時のあるあるアンチパターン20 - Qiita

業務でドキュメントを作成するケースは多々ある 例：仕様書・設計書・提案書・メール・障害票．．． ここでは各ドキュメント共通してありがちなアンチパターンをまとめてみました。 1. 表記がバイト表示・マイクロ秒表示 プログラムが出した数値をありのままに表示するパターン ファイルサイズが100MB, 1GBあろうと、バイト表示にする 桁数が多い数値に、桁区切り（,）を入れない 時間を何でもマイクロ秒・ミリ秒にする（1/100万秒までの精度が必要？体感で分かる？） 桁数が多い＝精度が高い＝良い文書、ではなく、見る人が必要とする精度に切り上げることが重要（売上で１円単位まで出すことが無いのと同様） 悪い例 No ファイル名 ファイルサイズ(byte) 処理時間(秒)

[berlysia]

「悪いパターン」に対して「ましなパターン」というのがwabi-sabiを感じる もっとよくしていこう💪

[rjge]

時間を置いて見直すのほんと大事。特に夜書いた資料とラブレターは朝に見直せ。 / “人にチェックしてもらえない状況の場合、「時間を変えて資料を見直す」というのがいい”

[sky-y]

すごく大事なこと。実用文書であればどんな文書にも目的があるし、読むのは他人の誰かです。「この文書を書く目的は何か？」「誰が読むのか？」は、書く前に想像しましょう。

[buenaarbol]

参考なる。図はメンテナンス性最悪だけどな

[mosco-mule]

ドキュメント作成時のあるあるアンチパターン20 業務でドキュメントを作成するケースは多々ある 例：仕様書・設計書・提案書・メール・障害票．．． 同一人物が作成しているにも関わらず、その日の気分なのか統一しな

[raimon49]

とてもよい。時々見返して自戒したい。

[oki448jp]

ドキュメント作成時のあるあるアンチパターン20

[karia]

“見てもらいたい箇所を強調していない”

[june29]

パターン数が18から20に増えていたようなので、はてなブックマークの方のタイトルを更新しておきます。

[nyop]

あるある。

[escape_artist]

「トピック指向」で何もヒットしなくて悲しかった

[ota42y]

言い話すぎていい話

[ch1248]

すっげえ耳が痛い……。

[HF_frt1623]

自分の苦労話を聞いてほしい報告書、よくある。何を分かって欲しくて書くのか目的を明確にして文章推敲してると時間がかかって仕方がない。

[horimislime]

良い内容

[masaru_b_cl]

よい

[glat_design]

とても参考になる /

[labduck]

よいまとめ。コメントも良いです。

[civitaspo]

http://ift.tt/2cOYbni

[toyama0919]

自戒

[t-wada]

コメント欄も含め、良いまとめ

[kurihara99]

この辺、Wordだと最初に設定がんばっておけば回避できるようになる

[efcl]

文章のアンチパターンについて。 コメント欄にも色々書いてある

[mate_gai]

いいですね。

[northlight]

いつもレビューで指摘することばっかりだ。