レビューしてもらう/する場合に意識すること、やり方を考える

先日ドキュメントのレビューについて相談を受けました。 『レビューをしてもらう必要性はわかっているものの、いろいろツラい』とのこと。具体的に話を聞いてみると、以下のようなツラみがあるようです。 「わかるな〜」と思いつつ、「私はどうやってレビュー対応していたっけな？」というのを考えてみたいと思います。 レビューについてそもそもの話として、良いドキュメントを書くにはレビューが必要です。 他者に見てもらうことによって、足りない部分を補えたり、無駄な部分を省けてスッキリさせたりでき

ドキュメントを作る前に、ガイドラインを作ろう

ドキュメントサイトを運用するにあたり、必要になるのがガイドラインです。 ガイドラインとは何か​ガイドラインとは、ドキュメント作成のための手助けとなるガイドブックのことです。 主に、ドキュメント作成において適切なフォーマットやスタイル、書き方などを指導するための方針やルールが記載されます。 ガイドラインがあることで、文書作成において適切なフォーマットやスタイル、書き方などの指針を立てることができます。 ガイドラインの必要性​ガイドラインを用意することで、以下のことに役に立

ドキュメント作成のコツは、正しいことをわかりやすく書くこと

先日知人と話しているときに、「結局どんなドキュメントが一番良いのか？」と言う質問を受けました。 うーむ、としばらく考えたのですが、結論としては『正しいことをわかりやすく書く』かな、と答えました。 こうして改めて文章にすると当たり前のことしか言ってないな、という感じですが。。この当たり前のことができていないのだろうな、という気持ちになりました。 せっかくなのでもう少し深掘りしてみたいと思います。 ドキュメントには４種類あるドキュメントには下記の４種類あります。 正しくてわ

数学文章作法 基礎編と推敲編がとても素晴らしかったので紹介します。

概要結城浩さんの「数学文章作法 基礎編」と「数学文章作法 推敲編」を読みました。 私はドキュメントを書く仕事をしているので、それなりに文章を書くことが得意と思っていました。しかしこの本を読み、まだまだ知識として足りない箇所があるな、と襟を正しました。皆さんにも読んでいただきたいので、感想を書きます。 誰向けの本か「数学」とタイトルに入っていますが、数学に関係する方だけではなく、良い文章を書きたい人のための本です。 「なんでうまい文章が書けないのだろう」「自分の思っている

「できる研究者の論文生産術」を読みました。読んだ感想など。

最近は仕事でドキュメント書きまくっていると伝えたら、友人におすすめされまして「できる研究者の論文生産術」を読みました。 誰におすすめか？こんな方におすすめの本です。 技術ドキュメントを書きたい! 書いているけど、なぜか最後まで書ききれずWIPばっかり！ 納得のいく文章が書けない！ 書きたいけどそもそもスケジュールがない！ 上記の悩みは皆さんお持ちだと思うので。皆さんにおすすめです。 私は文章を書くには下記２つが必要だと思っています。 文章の書き方を学ぶこと

キーボードを変えたら英語でメッセージすることが多くなった友人の話。

友人の話。 最近友人がGitHubのレビューやSlackのメッセージをやたら英語で送ってくるんですよね。『急にどうしたんだろ、グローバル企業に転職したのか？』と思って理由を聞いたら面白かったので簡単にまとめます。 ことの始まりは、間違えてUSキーボードを買ってしまったこと結論から言うと、USキーボードを購入したら英語を書くようになった、と言うことらしいです。 もともとはJISのキーボードを購入予定だったのですが、間違えてUSキーボードを買ってしまったとのこと。ただ返品交

5歳、3歳、0歳の3人娘を育てている感想

去年三女が産まれて、もうすぐ１歳になる。月日が経つのはとても早い。 こどもの日ということなので、ちょっと振り返り。 前提私は５歳、３歳、０歳の3人娘がいて、Web制作のプロジェクトマネージャー・ドキュメントサイトのテクニカルライターをしています。 地方在住です。 まず娘たちは本当に本当に本当に本当に・・・可愛くてしょうがない。いつも一緒にいれるリモートワークに感謝。 一方で子育てに伴い様々な変化があったので、ここでまとめておきたいなと思ったのが始まり。3人以上を育てている

【現代版 孫子の兵法】元テレ東佐久間さんの「ずるい仕事術」を読んでの感想

プロダクトのドキュメント担当という仕事柄、様々なチームの方とやりとりすることが多いのですが、今のチーム、本当にとても優秀で真面目な人が多いなと感じます。 一方で、真面目な方は責任感も強い方が多い気がします。 責任感が強いことはもちろん良いことなのですが、責任感が強すぎるゆえ、タスクを自分で抱え込んでしまい、結果忙しくし遅くまで働いているなーという感覚があります。 つまり、優秀で真面目な人ほどたくさん働いている印象。 これはなんでだろう、と思ったのですが、優秀な人の中には「

ドキュメントサイトにおけるSEOの考え方

こんにちは。日々ドキュメントサイトを運営し、ドキュメントを書き、ドキュメントを届けるために頑張っております。 今回はドキュメントを届ける話です。 ユーザがどうやってドキュメントを探しにくるのかですが、Analyticsを見ていると、Google検索で探しにくることが多いです。 例えば私がnoteで有料マガジンを作成しようと思った場合、Google Chromeのアドレスバーに『note 有料マガジン　作成』と入力して検索します。 noteには、note help cen

体力の低下が著しくて、定期的に運動しようと思うのですが、 仕事+育児に加えてジム通いするのが時間取れなそうで結構しんどい感じでして。 何か続けられる運動ないかな。オススメあれば教えてください。

オーガニックの野菜を探していた方にCoCo壱を紹介したらめちゃくちゃ喜ばれたらしい。なぜか

八百屋でバイトしていた友人がいました。 その友人がバイト始めたての頃に、70歳くらいの女性が買い物にきたらしいです。 その女性はオーガニック野菜を探していたようですが、その当時の友人はオーガニックというのがよくわからず、その八百屋では特に取り扱ってなかったので、素直にないと言ったらとても困った顔をしたようです。 よくよく聞いてみると、その女性は単純にカレーを作りたかっただけのようでした。 詳しく聞くと、その女性はカレーをほとんど食べたことがないらしく、テレビでオーガニック

2021年末年始休暇に見たエンタメ

冬の休み中に見たエンタメをまとめます。 ワールドトリガー読もう読もうと思っていて、この年末年始に一気に見ました。めちゃくちゃおもしろい！ ワールドトリガーの良さは犬山さんのnoteに詳しく書かれているのでこちらをご覧ください。 私の好きな点をあげると 戦略・戦術・運で勝敗が決まること 怒りでパワーアップしないこと 冷静な人が多いこと 「やられること = 負け」ではないこと 逃げることも戦略に組み込まれていること といったところです。 また、登場人物が全員魅力