担当しているITサービスなどに何かしらのインシデントや障害が発生した時に、対処後のアクションとして報告書を提出して事象の内容を報告(レポート)する場合がある。 提出先は会社の偉い人だったりクライアントだったり。場合によってはユーザー向けに発表したり。事の顛末を報告して「今後同様のことを起こさないように努力します、ごめんなさい」をするのだ。どのように再発防止の努力するのかを書くものでもある。 主にクライアント向けのビジネス内容ではあるが、自分が使っているテンプレパターンを共有するので参考にしてもらえればと思う。1 全般的なポイント 心得のようなもの。次の点は留意してて欲しい。 淡々と冷静な説明をこころがける 当然のことながら事実は脚色しない。無駄な修飾も要らない。客観的な事実を簡潔に述べる。 例: ❌「一生懸命頑張って対応したが…」 ❌「寝ないで対応したが…」 ❌「本当の原因は…」 できるだ
今では200以上のルールがある自然言語のLintツールであるtextlintがどのように作られたかを振り返る記事です。 6月はMaintainer MonthというイベントをGitHubが主催しています。 Maintainer Month is a reminder for the ecosystem to support, celebrate, and compensate open source maintainers. – Maintainer Month Maintainer Monthは、オープンソースのメンテナーが集まって情報共有したり、メンテナーを祝ったり、支援したりするイベントです。 メンテナーがどういうサポートを求めているかを知る、負荷が特定の箇所に集中するエコシステムはバランスが悪いのでそれを支援する方法を知るといったことを思い出すのがMaintainer Monthの
どうして人間集団はこんなにも知見の共有を円滑にできないのか? 改善にはドキュメントにまつわる各個人の心構え・制度設計・技術的解決の全部が必要だという話をしたい. ここでテーマにしているのは,著名OSSなど世の中にいくらでも知見が転がっている対象ではなく,特に企業内の十数人のチームでクローズドに開発しているなどして集合知に頼れない状況下でのドキュメントについてである. 非常に乱暴な言い方をするなら,「コードとか大部分は誰でも書けるようになるものなんよ,そんなところにマッチョイズムとか感じなくてええねん,我々の知的体力や組織性が真に試されるのはドキュメントちゃうんか」という気持ちです — 画力・博士号・油田 (@bd_gfngfn) June 3, 2022 ドキュメントに書く内容の必須項目或るシステム(ソフトウェアなど)について,そのシステムのことを全く知らない人を想定読者としたドキュメント
哲学者であり作家としても活動している千葉雅也さんは、長年「書けない」悩みと対峙(たいじ)し続けてきた。 近年はSNSやブログなど、自分の言葉をアウトプットできる機会が増えた。そういった自己発信の場以外でも、企画書や取引先へのメールなど、「書く」という行為は私たちの生活と密接している。「書けない」悩みや「書く」ことへの苦手意識を抱く人も少なくないだろう。 それらの根底には「ちゃんとした文章を書かなければならない」という呪縛がある、と話す千葉さんに「書けない」悩みを克服する手がかりを伺った。 インターネットの広がりにより、ブログ、SNS、小説投稿サイトなど言葉で自己表現できる多種多様なサービスが身近な存在になった。文章を書く機会は増えたが、文章を書くハードルが下がったかといえば、意外とそうでもない。 何かを書きたい気持ちはあるのに、いざ書こうと思うと「うまく書けない」「まとまらない」。 読み手
マイクロコピーとは、Webサイトやスマホアプリのボタンのラベル、ボタンやフォームに添えるテキスト、エラーメッセージなどのUIデザインに使用される短いテキストのことです。優れたマイクロコピーを使用することで、入力ミスが少なくなったり、ボタンのクリック率があがったり、さまざまな効果を得られます。 思わずクリックしたくなるタイトル、迷わずクリックできるボタンなど見かけませんか? ボタンに書かれているラベル、ボタンに添えられたテキスト、これらに使われる文言はほんの少し工夫を加えるだけで、劇的な効果を発揮します。 WebサイトやスマホアプリのUIで使用する文言、ライティングのテクニックを身につけたい人にお勧めします。本書は「ザ・マイクロコピー(紹介記事)」の第2版で、内容は大幅にアップデートされています。 UIデザインで使用する言葉、ボタン、フォーム、ナビゲーションに使用する文言など、言葉の魅力でU
ウェブ制作の現場で一般的に使われるようになってきたデザインツール「Figma」。そのFigma上で動作する文章校正支援プラグイン「テキスト校正くん」を弊社からリリースしました。無料で利用できます。 テキスト校正くん for Figma 本プラグインを利用することで、画面内の文章を手軽に校正でき、テキストの品質を高めることができます。 「テキスト校正くん」はテキストエディターの「VS Code」(参考)や、デザインツールの「Adobe XD」向けの拡張機能(参考)として以前から公開しており、多くの方に利用いただいています。とくにVS Code版の「テキスト校正くん」は約4万インストールも利用されており、今も利用者が増えています。「テキスト校正くん」の校正機能をさまざまなツールで利用できるよう、今回はFigma向けのプラグインとして新たに開発し公開しました。 「テキスト校正くん」でできること
今日は、自分がつくっているノートアプリの紹介をさせてください。 背景私には、過去5年ほど個人的に愛用している長文を書くテクニックがあります。それを誰でも実践できるようにするアプリをつくりました。 仕事の合間にちょこちょこ手を加えていったのですが、そろそろ他の方のご意見を聞いてさらにアプリを良くしたいな、と思ったので、ベータテスターを募集するために、この記事を書いています。 ベータテスター募集はこちらから なぜつくりたいと思ったのか、きっかけみなさんは、普段どうやって自分の考えを整理して、発信していますか? 自分は、普段思いつく思考の断片はあるものの、それをまとまった形で人に読んでもらう状態にまでもっていくのに苦労していました。 思考の断片がどう進化するのか 自分たちの脳みそは グラフ構造 になっていると思うのですが、それを他人が読む形でアウトプット・発信するときには、思考のグラフを著者なり
Writing is an increasingly important skill for engineering leaders. Indeed, poor writing can hamper career progression, above a certain level. Tactics for more clear, more frequent and more confident writing. I’ve observed that my writing is not up to par with my peers. How can I improve my professional writing, as someone working in tech?I get this question from many people: senior engineers who
特殊詐欺被害を未然に防いだとして、大阪府警寝屋川署がこのほど、寝屋川市内のコンビニエンスストアの店長と銀行の社員の男女2人に感謝状を贈った。 「パンに虫が入っていた。裁判で損害賠償を請求しようと思います」 6月7日午前、ファミリーマート寝屋川寿町店に、客を名乗る男から、こんな電話があった。対応したのは統括店長の松本剛さん(34)。男の丁寧で紳士的な口調に逆に動揺を誘われたという。しかし、電話口の向こうから「相模原市役所の者です」という声が聞こえると、詐欺を疑った。 店員が苦情電話の対応をしている隙を狙い、被害者にATMを操作させる手口が相次いでいると、警察から聞いたことを思い出した。すぐに、ATMを確認すると、70代の男性が携帯電話を片手に、操作していた。男性が「市役所から還付金があると言われた」と話したことから、詐欺を確信。警察に通報し、被害を未然に防いだ。 今月12日にあった感謝状の贈
こんにちは丸山@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日 これらのドキュメントは個人的にわりと良く書けたと思ってますし、
こんにちは。ネット記者を20年近くやっている岡田有花と申します。記事の見出しをつけるのが好きです。見出しをつける専門の仕事もしています。 最近気になった見出しについて考えてみたいと思い、noteを書きました。 尾身会長が逮捕!? 誤解招いた見出し 今回題材にするのはNHKが8月12日に配信したこんな見出しの記事です。 「尾身会長が理事長の法人建物に侵入 玄関壊した疑いで逮捕」 この見出しを読んだ人はみんなびっくりしました。 尾身会長が/(どこかの)理事長の法人建物に侵入し/玄関を壊し/その容疑で逮捕された と読めるからです。「尾身会長、どうしちゃったの!?」ってなりますよね。 尾身会長が建物に侵入し、玄関を壊して逮捕された‼️🤣🤣🤣 ストレス溜まってたのかなぁ(笑) てか、この見出しだと誰もがそう思っちゃうよね😆😆😆 pic.twitter.com/dc1GKUDfii — s
オープンソースVOICEVOX は OSS(オープンソース・ソフトウェア)版 VOICEVOX をもとに構築されています。 製品版と OSS 版の違いやモジュール構成は VOICEVOX の全体構成 をご参照ください。 ソフトウェア部分は Electron + Vue 、音声合成エンジン部分は Python + FastAPI です。 追加したい・改善したい機能があれば、ぜひ開発にご参加ください。
学校で配布された「どくしょかんそう文のかきかた」というプリントが、「私の学生時代もこんなのが欲しかった」「読書感想文ってこういうこと書けばよかったのか」と話題を呼んでいます。 話題になっているのは小学1・2年生向けに配られているプリント。 話題のプリント 冒頭では「よみたい本をえらぼう」と読書感想文のテーマの選び方を指南しており、「のりものやきかいの本」「ものがたりの本」「ゆうめいな人の本(でんき)」「どうぶつやしぜんの本」と4つのジャンルの魅力を紹介しています。。 続く「どくしょかんそう文のくみたてを考えよう」では、「本をえらんだわけ」「あらすじ」「こころにのこったところ」「じぶんだったらどうするか」と順序だてて感想文を書く方法をアドバイス。具体的な例を出しながらの説明は年齢を問わず、わかりやすい内容となっています。 このプリントを紹介したのはTwitterユーザーの小麦こむぎ子(@co
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く