文科省の公用文作成の考え方って資料、めちゃくちゃ役立つから論文書く人とか社会人になって社外にメールを送るのが苦手って人は読むのをおすすめする。
ぎーち(ブレイク兄) @BREAK_BROTHER 小型衛星の電源屋さんでヤンス。趣味でも衛星開発やっとります。衛星に携わってる方はぜひ仲良くしてクレメンス… 東方サークル(ネタタイトル萌えジャケットガチクラシック人工衛星サークル)"Windbreaker"のネタタイトル人工衛星担当です。アイコンはかじつおひま様、ヘッダーは人間猫様に描いていただきました！ twpf.jp/BREAK_BROTHER リンク Yahoo!ニュース お願い「致します」漢字はNG? - Yahoo!ニュース 「よろしくお願いいたします」ビジネスメールでは常套句ともいえる一文に注目が集まっている。きっかけはX上のあるユーザーの投稿。そのユーザーは「よろしくお願いいたします」の「いたします」部分について、ひ 3 users
なかなかアウトプットできないあなたが技術記事を書くときのコツ
技術記事を書くまでのステップについて順にコツを解説していきます。 特に、技術記事を書きたくてもテーマ選定が難しい、文章が苦手だ、なぜか筆が進まない、うまくまとめられないといった方に読んで欲しい記事です。 一応、エンジニア歴としては数年以内のジュニアレベルの方を想定しています。 以下のように技術記事を企画して、書いて、公開するためのプロセスごとにちょっとしたコツをまとめています。気になるセクションだけでも読んでいただければ幸いです。 テーマを決めよう 対象読者を決めよう 章立てを決めよう 書こう タイトルを決めよう 【余談】技術記事を書く理由とは 筆者について QiitaとZennにて6年以上の記事発信経験があり、 Qiitaでは5,942Contributionsを記録、 Zennでは3,253Likesをいただいています。 テーマを決めよう コツ：テーマのカテゴリによって執筆のポイントや
プレゼンスライドがみるみる良くなる基本の推敲技術 -事例付き解説-｜石原尚（大阪大学教員）｜note
研究発表のスライドの仕上げの目的は、単に見栄えを良くすることではなく、伝えたいことが正しく・詳しく・分かりやすく伝わるようにすることです。スライドの推敲の技術を知って、実践的に身につけましょう。大阪大学大学院の教員であり、2021年10月に『卒論・修論研究の攻略本（森北出版）』を上梓した著者が実例付きで解説します。 スライドの推敲とは？文章がそうであるように、スライドもまた、「伝えたかったこと」をいつでも正しく伝えてくれるとは限りません。そして、正しく伝わるはずだ、という淡い期待を裏切られたときは、本当につらいものです。 文章を推敲するように、スライドにも推敲をかけましょう。ただし、スライドを推敲する際に、単にスライド中の語句を推敲するだけでは不十分です。スライドは、文章とは異なる表現形式だからです。 とはいえ、実は、著者の別記事で紹介した文章の推敲技術は、スライドの推敲にも使うことができ
プロが語る「初稿のプロットや設定資料を作る前にもう一工程あると作品は洗練される」
DK @game_sennin 制限文字数内でなんとか書き収めることがポイントなので文字数は厳守してください。 「たくさん書くぶんにはいいだろ」と思わずに、どうしたら収まるか、残す情報と削る情報をどう判断するか、よく吟味して書くことに意味があります。 あまりないかもしれませんが無駄に文字数だけ埋めるのもNG 2023-01-10 14:14:18 DK @game_sennin この工程を避けようとする自分がいたら気をつけてください。 「要するにどんな話なのか説明できない」「おおまかな結末すら考えられていない」「何が作品の一番の特徴か言えてない」など、かなり根本的な部分の構想が固まりきっていない可能性があります 2023-01-10 14:14:18
コーディングのようにノートを取る技術 - Qiita
はじめに 何かを学習するとき、ノートを取っているでしょうか？ 小学生の頃や中学生・高校生の時の「ノート」は紙に手書きだったかと思います。 しかし、最近になってからはパソコンを使ってノートを取る、という選択肢が増えました。 その変遷の中で生まれたパーソナル・ナレッジ・マネジメント(Personal Knowledge Management) という考え方があります。 その考え方を共有できたらと思います。 直感的なデジタルノート術の原罪 ケース1: ひたすらに手を動かす 学生の頃、黒板に書かれた内容をそのまま必死にノートに写している人がいたのを覚えていますか？ また、その人は成績が高かったでしょうか？ たいていの場合、成績は乏しい人が多かったと思います。自分もそのタイプでした。 手を動かすだけのノート術の不幸な点は、「考える」というアクティビティが行われないため、本当の意味で筋肉を動かすだけと
プログラマーに贈る、わかりやすい文章を書くための技法 - LIVESENSE ENGINEER BLOG
これは Livesense Advent Calendar 2022 DAY 8 の記事です。 転職ドラフトでエンジニアをしている verdy_266 です。 僕の2022年を振り返ると、採用広報チームでの活動を無視することはできません。転職ドラフトの開発を行う傍ら、昨年末に採用広報チームにジョインし、記事の執筆や校正に多くの時間を割いてきました。 今まで記事を投稿したことがなかったこちらのブログにも共作含め5記事を投稿し、11月には Software Design への寄稿の機会をいただくこともできました。文章を書くことが思った以上に好きなんだなと発見があった年でもありました。 made.livesense.co.jp made.livesense.co.jp made.livesense.co.jp made.livesense.co.jp made.livesense.co.jp 弊
伝わる文章 | 基本要素 | SmartHR Design System
相手に誠実に、わかりやすい文章を書くための心がけをまとめました。 どういう思考プロセスからどんな表現が生まれるのか、参考として実例を紹介しています。実際に読み比べ、SmartHRの従業員として何かを伝えようとするときの、参考にしてください。 伝わる文章のガイドライン何を伝えるかによって、必要な情報の量や説明の粒度は異なります。 情報が不足していたり、逆に情報が多すぎたりすると、読者が意図を読み取れないことがあります。 読み手となる相手の状況（読む場面、事前知識など）を踏まえ、言葉にする内容や表現を厳選することが大切です。 目的に合わせて情報を取捨選択する読者の目線に立ち、コンテンツの目的に合わせて情報を取捨選択しましょう。 実例1：法律や業務に関わる記事目的業務に関係する「厚生年金保険」について正確に知りたいと思っている人に、わかりやすく内容を伝える。 Before日本の年金制度は、全国民
マニュアル作成はじめの一歩。「因数分解ツリー」で業務の洗い出しをはじめよう | ZUU online
マニュアル作成の準備は、マニュアル作成の5W1Hの「What」で登場した「洗い出し〜対象業務の選定〜改善」の3段階を、さらに7つのステップに分けて下ごしらえします。 洗い出し ツリーで業務を俯瞰して見える化します。ツリーは周囲とすり合わせた後、リスト（表）にして情報を追加します。 対象業務の選定 洗い出した業務のなかから、マニュアル化する業務を選びます。 改善 マニュアル化する業務のプロセスを分解して、改善の視点で見直し、マニュアルの骨組みをつくります。 ステップ1 ツリーで業務を見える化する ツリーで全体を俯瞰する 準備の第1段階「洗い出し」はツリーの作成からはじめます。洗い出しの目的は、「業務の見える化」の先にある「マニュアル作成」の効果を高めることです。 ツリーは、樹木（ツリー）の形の図表です。モノやコトを、木が枝分かれするように分解して表わします。 ここでのツリーは、論理思考でおな
Diátaxis
A systematic approach to technical documentation authoring. Diátaxis is a way of thinking about and doing documentation. It prescribes approaches to content, architecture and form that emerge from a systematic approach to understanding the needs of documentation users. Diátaxis identifies four distinct needs, and four corresponding forms of documentation - tutorials, how-to guides, technical refer
Diataxisという思考ツールとしてのフレームワーク - Qiita
はじめに こんにちは。 KDDIアジャイル開発センターの小板橋です。 この記事は、KDDI Engineer&Designer Advent Calendar 2021の17日目の記事です。 今回は、Diataxisという技術文書作成のための体系的なフレームワークについてまとめていこうと思います。 Diataxisというフレームワーク 少し前に、Ubuntuの支援及び開発援助を行うCanonical社から「今後CanonicalでのドキュメンテーションはDiataxisフレームワークを用います」という宣言が発表されました。(https://gihyo.jp/admin/clip/01/ubuntu-topics/202111/19) Diataxisを要約すると、ドキュメントと名の付くものは全てTutorial、How-to Guide、Technical Reference、Explan
ソフトウェアドキュメント作法 - maru source
こんにちは丸山@h13i32maruです。つい先日、devchat.fmというポッドキャストに出演して、「ドキュメント」というお題について話しました。なぜこんなニッチなお題について話したかというと、Ubie Discoveryに入社して5ヶ月の間にいくつか*1まとまったソフトウェアドキュメントを書いたので、自分の中でホットな話題だったからです。 #devchatfm 33回目は、Ubie DiscoveryのSWE @h13i32maru にドキュメントを書くことで得られるメリットや、ポイント・工夫などを聞きました！ #33 チームの生産性を上げるドキュメントのすすめ with@h13i32maruhttps://t.co/TrmZd13D91— 久保 恒太 / Ubie CEO (@quvo_ubie) 2021年8月12日 これらのドキュメントは個人的にわりと良く書けたと思ってますし、
簡潔で分かりやすい英文を書くためのコツを整理した - Unboundedly
職場で開催されていた「英語が母国語の人たちを対象とした英作文のコース」で学んだことを引き続きまとめます。 前回は英語論文を書く上で、どのような戦略で原稿を書き進めればよいかについて整理しました。 具体的には次の３ステップの順に執筆することで、効率のよいライティングが可能とのことでした。 論文全体の構造・ロジックの流れを決める パラグラフを書く センテンスレベルで文章を洗練させる ステップ１で決めた骨組みにしたがって、ステップ２ではパラグラフライティングのお作法にしたがってとにかく無心で手を動かして文章化していきます。 ここまででドラフト作成はほぼ完了です。 あとは英文を一つ一つ洗練させていくことで、より簡潔で分かりやすい文章を目指していきます。 今回はこの最後のステップ３を掘り下げていきます。 基本的にはコースで紹介されたこちらのテキストに書かれている内容です。 文章としては完結している
質の高い技術文書を書く方法 - As a Futurist...
大学や大学院で論文の書き方を鍛え上げた人たちには遠く遠く及ばないが、僕の様なはぐれもの1でも最近は Amazon 社内で文書の質が高いと評価してもらえるまでにはなった。Software Engineer として、コードでのアウトプットはもちろん大事だけど、文書のアウトプット(およびそれによって得られた実際のアウトプット)は同じだけ重要である2。今回は自分が最近どういうところに気をつけて技術文書を書いているのか、ということについて数年後の自分が忘れてないことを確かめられる様にまとめておく。 そもそも文書とは？ 英語だと document。ここで指す(技術)文書とは、人間が読む文体で書かれた技術に関連する情報、といったものだ。具体的に言うと以下の様なものを想定している: 新しいプロジェクトの骨子を説明する資料 会議の叩き台となる 1 枚ペラ 本番環境に変更を加えるにあたっての包括的な情報や具体
LINE社内で大評判のテクニカルライティング講座で説明した内容をあらためてブログにまとめてみた
LINE株式会社は、2023年10月1日にLINEヤフー株式会社になりました。LINEヤフー株式会社の新しいブログはこちらです。 LINEヤフー Tech Blog こんにちは、Developer Contentチームの矢崎です。LINE株式会社でテクニカルライターとして働いています。今日は、私が1文を書くときに気をつけていることや手法についてお話しします。 そして、この書き出しは、6月にmochikoさんが書いた「LINEの社内には「テクニカルライティング」の専門チームがあります」という記事のオマージュになっています。mochikoさんが書いた記事ですごいpvをたたき出したそうなので、人のふんどしで相撲を取ってみようという作戦で始めてみました。 この記事ではLINE社内で私が講師を務めた「LINE社内で大評判のテクニカルライティング講座」に沿って、わかりやすい1文を書くコツを紹介していま
ビジネス資料のGitHub化ーーNotion2.0が目指す「テンプレ図書館」の衝撃 - BRIDGE（ブリッジ）テクノロジー＆スタートアップ情報
Almanacウェブサイト プログラミングをせずとも、ウェブもしくはモバイルアプリを直感的に構築できるノーコードサービス分野が成長してきました。「Bubble」や「AppGyver」のようなアプリ開発、日本の「STUDIO」や「Strikingly」に代表されるLP開発など、領域は様々です。ノーコードの本質は、時間やコストを圧倒的に削減することにあります。そして今、ノーコードトレンドの考えが新たな体験として企業で広く使われるドキュメント作成分野にも広がりつつあります。 「Almanac」は、ビジネスドキュメントテンプレートのクラウドライブラリを提供。マーケティング、人事、法務テンプレートなど、専門家によって公開された、磨き上げられた1万件の文書を提供しています。各資料をコピペすれば、ユーザーは手軽にプロのドキュメント内容をトレースできます。UIはノートツール「Notion」にとても似ていま
LINEの社内には「テクニカルライティング」の専門チームがあります - LINE ENGINEERING
こんにちは、Developer Contentチームのmochikoです。LINE株式会社でテクニカルライターとして働いています。今日は「テクニカルライター」というお仕事と、LINEにあるテクニカルライティングの専門チームについてお話しします。 テクニカルライターという職種があります テクニカルライターって何をしてるの？何を書くの？ ドキュメントはどうやって書いてるの？ どんなメンバーで仕事をしてるの？ ドキュメントを書く以外にこんなこともしているよ でもドキュメントを書くだけだと技術力が下がらない？ どんな人がテクニカルライターに向いてるの？ テクニカルライターという職種があります 私はもともとウェブ制作会社のインフラエンジニアでした。とある技術書を書いたことをきっかけに「テクニカルライターとして一緒に働きませんか？」と声をかけてもらい、LINEへ転職するに至ったのですが、実はお誘いをい
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
技術をわかりやすく伝えるためテクニカルライティング
Language Search — Writefull
テクニカルライティングの基本
小説の推敲補助ソフト「Novel Supporter」に隠れた文章癖をあぶり出す分析機能／文字種・文章長・段落長などの推移をグラフ化
