エントリーの編集
エントリーの編集は全ユーザーに共通の機能です。
必ずガイドラインを一読の上ご利用ください。
読み手に配慮した技術文書って何だろう - Neo's World
記事へのコメント0件
- 注目コメント
- 新着コメント
このエントリーにコメントしてみましょう。
注目コメント算出アルゴリズムの一部にLINEヤフー株式会社の「建設的コメント順位付けモデルAPI」を使用しています
- バナー広告なし
- ミュート機能あり
- ダークモード搭載
関連記事
読み手に配慮した技術文書って何だろう - Neo's World
読み手に配慮した技術文書って何だろう システム開発における、設計書や手順書などのドキュメント類。僕... 読み手に配慮した技術文書って何だろう システム開発における、設計書や手順書などのドキュメント類。僕が書いたドキュメントは概ね「分かりやすい」と評価される一方、上長からは「もう少し読み手を意識して書くと良いかも」と忠告を受ける。 …読み手を意識した結果がこのドキュメントであって、その狙いはうまく行っていることが今分かったんだよなぁ。 一般的に、「技術文書は誰にでも分かりやすく書くべし」というのはよく聞くと思う。それもそうなんだが、限度というモノがある。「AWS コンソールにログインして、S3 のバケット一覧画面を開いて…」というこの一文で理解できない人に、果たして理解してもらう必要があるのだろうか? この案件に未経験の新人が入ってきて、既存メンバと同等のタスクをこなすことはない。この案件に参画するメンバ自体がそもそも殆どいない性質のモノだ。このドキュメントを分かれば良い人というのは、既存メン