読みやすいドキュメントを書くために今日からできる7つのこと｜壮｜Masato Tanaka
こんにちは。壮（@sew_sou19）と申します。 メガベンチャー企業でエンジニアとして働いています。 エンジニアにジョブチェンジした当初は、ドキュメントの書き方なんてこれっぽっちも分かりませんでした。読みやすいドキュメントを書くことが本当に苦痛だったのですが、考えて、試行錯誤し続けた結果、以下のような評価を得るに至りました。 リーダーから「君は情報の整理が上手でドキュメントが本当に読みやすい。チーム全体の能力向上に繋げたいからドキュメント書く際のポイント共有してほしい」と言われたので、意識していることを言語化しつつテクニカルライティングの本でインプットしてるけど、学びが多い。ついでにnoteにもまとめてる — 壮 (@sew_sou19) November 28, 2022 そこでこのnoteでは、僕がドキュメントを作成するときに、特に意識して実践している7つのことを書きます。（本当は2
穴埋めするだけで論文を作れるWebフォーム 便利すぎて無情な現実を突きつけてくると話題に
「めちゃくちゃ有用だけど、きつい現実を突きつけられる」──こんな口コミで、あるWebサイトが話題になっている。「データはどのように収集しましたか？」「この論文で検証したいことは何ですか？」など複数の設問に回答することで、論文の骨組みを出力してくれるWebフォームだ。 設問は、データの正確性、研究の正確性、研究の意義、研究の必要性の4種類に分かれており、それぞれのテーマに沿った質問を用意している。入力した後は「論文骨子へ変換」をクリックするだけで、論文タイトルから要旨、実験方法、結論などを表示する。 作成したのは「独学大全」などの書籍で知られる、作家の読書猿（@kurubushi_rm）さん。自身のブログに「論文に何を書くべきか→これだけは埋めろ→論文作成穴埋めシート」と題して2012年2月に投稿したものだ。「穴埋めしたら論文を出力してくれるものが作れないか」という話を受けて、シートを作成し
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
テクニカルライティングの基本
