伝わる説明を書くスキル - Qiita
Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article? 説明って難しいなと思う機会があり、備忘録的に記します。 前提 ここで言う「説明」は文面で行われるものを指します。（文面がない状態で口頭で即興で行う説明は指しません） 例として挙げているのはコードレビュー時の説明です。 伝わる説明を書くには ①前提を省かない ■NG例 説明：「Hogeクラスのhogehogeメソッドに対して修正を入れた。hogehogeはFugaクラスから呼び出されているが、これはFugaFuga機能でのみ使われているため、全体として支障はない」 疑問：「なんでFugaFuga機能でのみ使われている場合には支障がないと言
エンジニアのためのドキュメント力基礎講座〜構造化思考から始めよう〜（2025/02/15jbug広島#15発表資料）
https://jbug.connpass.com/event/342193/ 「jbug広島#15 「ド。」～文書の運用について～」にて発表した資料です。
「テクニカルライティング」で、伝わる文章を書くコツ - トラストバンクテックブログ
こんにちは。トラストバンク パブリテック事業部 プロダクトグループのみきです。 自治体職員専用ビジネスチャットの「LoGoチャット」をメインに、複数の自社プロダクトをサポートしています。 LoGoチャット上でお問合せ対応をする中で、分かりやすい文章作成技術を学びたいと思うようになりました。 そこで今回は、書籍を通して学んだ「テクニカルライティング」について、紹介します。 テクニカルライティングとは テクニカルライティングのポイント 1. 一文一義で書く 2. 一文50文字程度で書く 3. 結論から書く テクニカルライティングの活用シーン 1. 社内のコミュニケーション 2. ユーザーマニュアルの作成 「読み手」と「目的」を想定する 読み手の目的別に、マニュアルを構成する 「参考情報」や「注意文」など、情報の要素を分けて書く 3. 障害報告書の作成 分かりやすく書く 主担当者以外にも伝わるよ
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
sazan on Twitter: "OpenAIからヤバすぎる論文出た。必読 * 就くのが困難な仕事ほどGPTに置き換えられやすい * 給料が高い仕事ほど（略 * プログラミングとライティングを使う仕事が（略 * どのような仕事がなくなるかを人間とGPT-4に聞い… https://t.co/8cIzgvMkGz"
じゅじゅ on Twitter: "cybozuの新入社員向け研修資料「テクニカルライティングの基本」(無料公開)が超勉強になった...！ 本来は技術的な内容をわかりやすく伝えるための方法論だけど、リモートが普及しテキストコミュケーションが重要になった今、非技術者で… https://t.co/3tmqqCjhH0"
