エンジニアが一生困らないドキュメント作成の基本（仲田 尚央） | 書籍 | ソシム

2024/11/24 338 users ソシム 後回し 本書 スペシャリスト ドキュメント

「コードを書くのは好きだけどドキュメントは苦手」 「ドキュメントはつい後回しにしてしまう」 エンジニアの皆さん、そんな覚えはありませんか？ 本書は、日本語ドキュメントのスペシャリストであるテクニカルライターの著者が、エンジニアが「いつ」「何のドキュメントを」「どうやって」書けばよいのかを、イチから解... 続きを読む

テクニカルライターよ概念図を描くのです 〜テクニカルライターのためのイラストテクニック２〜 / cybozu illust technique2

2023/01/19 178 users

ドキュメントでは、「モノや人の関係を明確に表わす」「複雑な流れをわかりやすく説明する」といった場面がたくさん出てきます。概念図は、言葉だけでピンとこない複雑な関係も、わかりやすく伝えることができます。 本セッションでは、テクニカルライター向けに概念図を描くテクニックをご紹介します。 続きを読む

テクニカルライティングの基本

2022/06/09 1818 users テクニカルライティング ローカライズ naoh_nak 内容

Transcript テクニカルライティングの基本 2022年5月17日 開運研修2022 開発本部 テクニカルコミュニケーションチーム 仲田 1 2 仲田 尚央 Nakata Naohiro @naoh_nak 開発本部 テクニカルコミュニケーションチーム テクニカルライター/ローカライズ 職能マネージャー お仕事の内容： ⚫ サイボウズ製品のUIテキストを書... 続きを読む

開発ドキュメントの書き方。意識したい9つのこと【技術編】

2022/05/07 375 users 開発ドキュメント 技術編 書き方 9つ 述語

テクニカルライター。開発者向けのドキュメントを書いています。元エンジニア。共著で「現場で使えるRuby on Rails 5」を書きました。趣味はスプラトゥーンです。 目次 文章を書く前にやること 開発ドキュメントの書き方 1. 一文を短く切る 2. 結論を先に述べる 3. 指示語を使わない 4. 主語を明確にする、述語との距離... 続きを読む

不動産の広告にはマンションポエムという特徴的なコピーや言い回しがありますが、何故あれは生まれたのでしょうか？どなたか分析していただけませんか？

2021/12/06 1062 users 言い回し マンションポエム コピー 不動産 広告

回答 (2件中の1件目) ポエマー歴25年の私の出番だと思います。 普通の広告コピーも書きますし、カタログのテクニカルライターみたいなこともしますが、大きくは、マンションポエムで25年、飯を食ってきましたし、私以上の回答はないと思います。なぜ、マンションポエムが生まれたのかまでは難しいですが、マンション広告... 続きを読む

リモートワークの知見共有 - Speaker Deck

2021/04/17 121 users リモートワーク Speaker Deck 知見共有 Sat

Transcript リモートワークの知見共有 Apr. 17, 2021 Satoru Takeuchi Twitter: @satoru_takeuchi, @EnSatoru 1 Who am I? • 武内 覚(通称 sat) • 仕事 ◦ Web系企業のインフラソフトウェア技術者 ◦ テクニカルライター ◦ ツイ廃 • リモートの経験 ◦ コロナ前から3年ほど(一人)リモート&めっちゃ苦労してきた 2 はじめに ... 続きを読む

分かりやすいドキュメントを書く「テクニカルライター」という仕事 / About the job "Technical writer" who writes easy-to-understand documents - Speaker Deck

2021/03/11 335 users Technical writer ドキュメント 00-21

Transcript LINE Technical Writing Meetup vol.1 分かりやすいドキュメントを書く 「テクニカルライター」という仕事 LINE Corporation Developer Content Team Yoshiko Horikoshi 11th March 2021 19:00-21:00 1: これだけ気を付けて書いてもらえると みんな幸せになるポイント2つだけ 2: 分かりやすいドキュメントを... 続きを読む

LINE社内テクニカルライティング講座第2弾！1文では説明が終わらない文章を書くコツ - LINE ENGINEERING

2020/08/21 748 users LINE Engineering 文章 コツ 説明 1文

こんにちは、Developer Contentチームの矢崎です。LINE株式会社でテクニカルライターとして働いています。先日、このLINE Engineering Blogで「LINE社内で大評判のテクニカルライティング講座で説明した内容をあらためてブログにまとめてみた」というタイトルで、1文を書くときに気をつけていることや手法について紹介し... 続きを読む

LINEの社内には「テクニカルライティング」の専門チームがあります - LINE ENGINEERING

2020/06/17 258 users テクニカルライティング mochiko 職種 line 社内

こんにちは、Developer Contentチームのmochikoです。LINE株式会社でテクニカルライターとして働いています。今日は「テクニカルライター」というお仕事と、LINEにあるテクニカルライティングの専門チームについてお話しします。 テクニカルライターという職種がありますテクニカルライターって何をしてるの？何を書くの... 続きを読む

もう迷わない！「」『』（）【】の“使いどころ"／テクニカルライターが教える、文章の見た目を良くする技術 | きんどるどうでしょう

2013/08/23 1715 users リテラシー Kindle作家 記号 ぎん ゲストポスト

もう迷わない！「」『』（）【】の”使いどころ”／テクニカルライターが教える、文章の見た目を良くする技術 2013年8月23日・ゲストポスト, リテラシー・晴海まどか この記事はKindle作家の”晴海まどか”さんからゲストポストいただきました こんにちは、もう覚えていただけましたでしょうか、晴海まどかです。「テクニカルライターが教える、文章の見た目を良くする技術」第3回。 今回は、記号の使い方で文... 続きを読む