テクニカルライティングで技術をわかりやすく伝えよう！テクニカルライティング勉強会開催記 - LIVESENSE ENGINEER BLOG
先日、社内でテクニカルライティングに関しての勉強会が開催されました。 リブセンス社内の多数のエンジニアが参加し、大盛況となりました。この記事ではそんな勉強会の模様を紹介します。 概要 開催の経緯 エンジニアブログの記事を自信を持って書いてもらえるようになってほしい 良い文章とはどんな文章かの共通認識を作りしたい 講義の内容 テクニカルライティングの基本的な考え方を知る 伝える情報を整理する アウトラインを作る トピック単位で文章構成の骨組みを作る わかりやすく、簡潔な文章で書く 質疑応答 最後に 概要 今回の勉強会では、外部より仲田 尚央さん(@naoh_nak)に講師をお願いしました。テクニカルライティングの分野で多方面で活躍されている方です。「ヘルプサイトの作り方」という本の著者であり、「テクニカルライティング ✕ UX」をテーマにした勉強会の主催もされています。 https://ww
エンジニアはもっと図を書こう - 生涯未熟
たまには軽い話題をば。 自分の中で信頼できるエンジニアかどうか？を見極めるひとつの指標で「込み入った議論の時に図を書くかどうか」というのがあります。 今までの経験上、図を書く派のエンジニアは割と良い感じの人が多かったので採用している指標なのですが、何故これが機能しているかというのを改めて考えてみた。 他者の認知負荷を理解している コンテクストを合わせることにコストをかけられる意識がある 自分の思考の整理するツールとして図を扱えている ザッと挙げましたが、この３つが機能している要因なのかなという気がしています. 他者の認知負荷を理解している あれやこれやエンジニア間で技術議論している中で、「Aさんはこの領域に詳しいけどBさんはこの領域にはほどほど詳しいくらいだな」という個々のレベル差に応じて認知の負荷がかかります。ただでさえ議論していると結構なスピードで話が展開されていくので、認知負荷が更に
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
