気に入った記事をブックマーク
- 気に入った記事を保存できます
保存した記事の一覧は、はてなブックマークで確認・編集ができます
- 記事を読んだ感想やメモを書き残せます
- 非公開でブックマークすることもできます
エントリーの編集
エントリーの編集は全ユーザーに共通の機能です。
必ずガイドラインを一読の上ご利用ください。
記事へのコメント16件
- 注目コメント
- 新着コメント
xlc
そもそもここで言う「ドキュメント」とは何を指すのか。Qiitaとかなら「間違えやすいことを正しく伝える」意識で書いて欲しいね。「誰でも知ってることをフォーマットに従って書き直してドヤる」が多すぎる。
vndn
「良い例」が受け入れがたい。極めてわかりにくいと感じるのは私だけなのか。『「認知特性」の有効性について説明する。』と書いてあるけど、「認知特性」の有効性を説明してるように見えないからかなあ。
xlc
そもそもここで言う「ドキュメント」とは何を指すのか。Qiitaとかなら「間違えやすいことを正しく伝える」意識で書いて欲しいね。「誰でも知ってることをフォーマットに従って書き直してドヤる」が多すぎる。
catalog360
“悪い例”はやることとその理由が最初に端的に述べられ分かりやすいが、後の用語の説明は上手くない。だが“よい例”は向かう先が知らされぬまま用語の説明が続き、やっと最後に具体策を言うのでもっと悪い。
Wafer
https://note.kishidanami.com/n/n6cc7d7d8a1de "難関中学の入試問題の原作者になったけど設問が解けない理由を考えて、編集者にたどり着いた" とあわせて読むとより面白い
注目コメント算出アルゴリズムの一部にLINEヤフー株式会社の「建設的コメント順位付けモデルAPI」を使用しています
いまの話題をアプリでチェック！
- バナー広告なし
- ミュート機能あり
- ダークモード搭載
関連記事
読みやすいドキュメントを書くために今日からできる7つのこと｜壮｜Masato Tanaka
こんにちは。壮（@sew_sou19）と申します。 メガベンチャー企業でエンジニアとして働いています。 エン... こんにちは。壮（@sew_sou19）と申します。 メガベンチャー企業でエンジニアとして働いています。 エンジニアにジョブチェンジした当初は、ドキュメントの書き方なんてこれっぽっちも分かりませんでした。読みやすいドキュメントを書くことが本当に苦痛だったのですが、考えて、試行錯誤し続けた結果、以下のような評価を得るに至りました。 リーダーから「君は情報の整理が上手でドキュメントが本当に読みやすい。チーム全体の能力向上に繋げたいからドキュメント書く際のポイント共有してほしい」と言われたので、意識していることを言語化しつつテクニカルライティングの本でインプットしてるけど、学びが多い。ついでにnoteにもまとめてる — 壮 (@sew_sou19) November 28, 2022 そこでこのnoteでは、僕がドキュメントを作成するときに、特に意識して実践している7つのことを書きます。（本当は2
ブックマークしたユーザー
すべてのユーザーの
詳細を表示します
詳細を表示します
2023/02/04 リンク