Transcript テクニカルライティングの基本 2022年5月17日 開運研修2022 開発本部 テクニカルコミュニケーションチーム 仲田 1 2 仲田 尚央 Nakata Naohiro @naoh_nak 開発本部 テクニカルコミュニケーションチーム テクニカルライター/ローカライズ 職能マネージャー お仕事の内容： ⚫ サイボウズ製品のUIテキストを書…
開発ドキュメントの書き方。意識したい9つのこと【技術編】
テクニカルライター。開発者向けのドキュメントを書いています。元エンジニア。共著で「現場で使えるRuby on Rails 5」を書きました。趣味はスプラトゥーンです。 目次 文章を書く前にやること 開発ドキュメントの書き方 1. 一文を短く切る 2. 結論を先に述べる 3. 指示語を使わない 4. 主語を明確にする、述語との距離…
分かりやすい文章を書くために、私が意識していること
はじめに 私は、仕事でもプライベートでも分かりやすい文章を書くことを大事にしています。 文章が分かりにくいと、読む人がストレスを感じたり、質問や確認が増えて時間のロスに繋がったりすると思うからです。 『分かりやすい文章を書くために、私が意識していること』というタイトルでLTをしたところ、ありがたいこと…
なるべく早く身につけたいエラーとの向き合い方 – Qiita
どんな記事か？ こちらのイベント参加の記事になります。 筆者自身がもっと早く身につけておけば、コーディングが楽だったなと思うことを記事にいたします。 環境 PC: MacBook Pro (Intel Core 2016) OS: macOS Montery12.3.1 Chrome: Version 100.0.4896.127 最初の頃は恐いエラーだが、仲良くなるとこれ以上の情報はな…
Obsidianは最高のマークダウン『メモ』アプリである
僕は今までマークダウンエディタを資料作成ツールとして使ってきました。見出しやリスト、表を簡単に記述でき、それをCSSで整形して表示できるマークダウン記法は、ブログの下書きや業務で使うPDFなど、「他人に見せるための資料を作る」という役目にピッタリです。 逆に言えば、個人的なメモには向いていないと思ってい…
【翻訳】Googleのエンジニアがソフトウェア開発する時に必ず書くドキュメント「Design Docs at Google」 – BppLOG
Googleでの「Design Docs」とは 2007年の Google Developer Day Tokyo での鵜飼氏のプレゼンによると「Google で必ず書くことになっているドキュメント」であり、「プロジェクト立ち上げ時の 1～2週間をかけて書く」ものです。 今回は Google のソフトウェアエンジニアである @cramforce 氏が自身のブログで「Googleでの…