良いドキュメントを書きたくなる本を読んだらドキュメンタリアンになりたくなった - じゃあ、おうちで学べる
ドキュメンタリアンとは、役職に関係なく、ソフトウェア業界でドキュメントとコミュニケーションに関心を持つ人のことです。 www.writethedocs.org はじめに これは主に『ユーザーの問題解決とプロダクトの成功を導く エンジニアのためのドキュメントライティング』の書評です。私はSreakeにてSREという役職についています。SREはサービス概要、アーキテクチャの解説や図、各種構成図、各種手順書、ポストモーテム、ポリシー、SLA(SLO) … その他の様々な場面でドキュメントを書く必要があります。しかし、ドキュメントは価値が見えにくく時間と労力がかかり品質担保の面で重要度がとても高いのにその場での価値が見えにくいので浸透しにくいです。そのため、エンジニアとしてモチベーションが保ちづらいです。2021年 State of DevOps 2021 にもドキュメントに関する言及があり今後、
論文執筆/プレゼン資料作成時の参考資料 - Qiita
はじめに 本記事では，論文執筆やプレゼン発表の際にnegocia社内で参考にしている資料を @aiueola さんと一緒にまとめました．もし何かの参考になれば幸いです． (また，もし関連リソースをご存知の方がいらっしゃれば，ぜひ本記事のコメント欄にご紹介いただけると嬉しいです．内容を確認の上，追記させていただきます．) negocia株式会社について negocia株式会社では，「うれしい広告」の実現をミッションとして，機械学習，数理最適化の技術を活かしたオンライン広告向けのSaaSを開発するメンバーを募集しています．この記事を読んで興味を持たれた方がいらっしゃいましたら，こちらのリンク よりご応募ください．ご連絡お待ちしています． 目次 研究事始め/論文サーベイ テクニカルライティング/論文執筆/レビュー テクニカルライティング全般 論文執筆 レビュー/リバッタル/ポジションペーパー プ
ライティング力が勝手に上達する「写経」
文章が上手になる方法 「文章」や「記事」を書くことが苦手な方は是非参考にしてください。 「文章を書く」と聞いただけで諦めてしまう方が多いのも現実です。 そもそも「文章を書く」事が苦手な方の原因ははっきりしています。 はっきり言いますが、原因は「練習してない」からです。 「では、今までに文章を書く練習をどのくらいしましたか？」 ほとんどの方が「やっていない」と答えます。 書けないのではなく、やっていないだけです。 文章を上手になる方法は「書いた量＝実力」と言うことです。 つまり、書けば書くほど上達します。 更に、ほとんどの人が「練習していない」のです。 今から始めても全く遅くはありません。 文章が溢れるトレーニング 「文章が上手くなりたい」 そんな方には「写経」をお勧めします。 「写経」とは「好きな文章そっくりそのまま書き写す」作業です。 句読点やスペースも全く同じように写してください。 手
「Otter」「DeepL翻訳」「Grammarly」など、便利なAIツールを駆使して英文ライティングに挑戦 - ENGLISH JOURNAL ONLINE
「Otter」「DeepL翻訳」「Grammarly」など、便利なAIツールを駆使して英文ライティングに挑戦 近年は人工知能（AI）を活用した自動翻訳や自動添削ツールが増えています。Otter、DeepL翻訳、Grammarlyなど、自分の英語力の足りない部分を補ってくれる便利なAIツールを駆使して、英文ライティングに挑戦してみましょう。 英文ライティングに自信がない人に助け舟リーディングやスピーキングの練習に比べると、後回しになってしまいがちなライティングですが、単なる語彙力や文法力だけでなく、表現の豊富さや、文章の構造など、総合的な語学力が求められる、非常に高度な分野だと言えます。英語の上達を目指している人ならば、常日頃からライティング力を高める勉強をしておきたいものです。 とはいえ、誰もがそんなに律儀で計画的とは限らないのが現実です。実際には、「来週までに英語で資料を準備しておかねば
UXライティングとは | UXライティングガイド
UXライティングとは何か UXライティングとは、ユーザーがデジタルサービスを操作する際に必要となるテキストを書く技術です。例えば、登録時のスタートガイド、利用の流れコンテンツ、タイトル、ボタン、画面上の説明文、エラーメッセージ、通知などの言葉がUXライティングの手法に則って書かれます。サービスの中にある言葉に対して「意味が通じればいい」という思想で書くのではなく、「ユーザーがサービスを通じて体験する一連の経験を設計する」という思想で書くのがUXライティングです。 UXライティングに求められる技術とは UXライティングには、分かりやすく書く技術と、人間らしく書く技術が必要です。この二つの技術が同居することによって、ユーザーの体験を支援することができます。 分かりやすく書く技術 UXライティングの手法に則ってテキストを書く際に求められるのは、「ユーザーの気持ちに沿った文章を書く」という抽象的な
LINE社内テクニカルライティング講座第2弾！1文では説明が終わらない文章を書くコツ
こんにちは、Developer Contentチームの矢崎です。LINE株式会社でテクニカルライターとして働いています。先日、このLINE Engineering Blogで「LINE社内で大評判のテクニカルライティング講座で説明した内容をあらためてブログにまとめてみた」というタイトルで、1文を書くときに気をつけていることや手法について紹介しました。 前回の記事を簡単にまとめると「たくさんの文案を書いて、一番良さそうなものを選択することがとても大切です」という話を多くの例文を使って説明しました。まだ読んでいない方はぜひ読んでみてください。 今回の記事は、第2弾です。次のステップとして「1文では説明が終わらない文章をどのように組み立てていくとわかりやすいか」という話を、以下のような文章を例に説明していきます。 ここでは、このくらいの情報量の文章を「トピック」と呼びます。 第2弾を最後まで読む
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
https://twitter.com/developer_quant/status/1551910433858400256
テクニカルライティングの基本