ドキュメント作成時のあるあるアンチパターン20 - Qiita
業務でドキュメントを作成するケースは多々ある 例：仕様書・設計書・提案書・メール・障害票．．． ここでは各ドキュメント共通してありがちなアンチパターンをまとめてみました。 1. 表記がバイト表示・マイクロ秒表示 プログラムが出した数値をありのままに表示するパターン ファイルサイズが100MB, 1GBあろうと、バイト表示にする 桁数が多い数値に、桁区切り（,）を入れない 時間を何でもマイクロ秒・ミリ秒にする（1/100万秒までの精度が必要？体感で分かる？） 桁数が多い＝精度が高い＝良い文書、ではなく、見る人が必要とする精度に切り上げることが重要（売上で１円単位まで出すことが無いのと同様） 悪い例 No ファイル名 ファイルサイズ(byte) 処理時間(秒)
技術的な文章を書くための第0歩 ～読者に伝わる書き方～ - Qiita
はじめまして。ひつじです。 TechBoosterというウェブサイトでAndroidなどの記事をかいてます。Qiitaには初めて投稿します。 vvakameさんの技術的な文章を書くための1歩、2歩、3歩 を見る人の補助的な気持ちで0歩目を紹介します。 記事の構成方法については、vvakameさんの記事で触れられてることもあり、あまり触れません。 読みやすい文章のための心得をまとめました。 0歩というぐらいなので普段から気を付けている（そして完璧には、こなせていない）内容をまとめています。ただ内容については私自身が気を付けていることですので、もっと皆さんにあった良い方法があるかもしれません。参考になれば幸いです。 文章を書くのに大切なことって？ 言いたいことを1つに絞る １つの文章にたくさんの主張を入れると読む人は混乱してしまいます。ですので、なるべく1つのコンテキスト（章、節、項で主張の大
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
