質の高い技術文書を書く方法 - As a Futurist...
大学や大学院で論文の書き方を鍛え上げた人たちには遠く遠く及ばないが、僕の様なはぐれもの1でも最近は Amazon 社内で文書の質が高いと評価してもらえるまでにはなった。Software Engineer として、コードでのアウトプットはもちろん大事だけど、文書のアウトプット(およびそれによって得られた実際のアウトプット)は同じだけ重要である2。今回は自分が最近どういうところに気をつけて技術文書を書いているのか、ということについて数年後の自分が忘れてないことを確かめられる様にまとめておく。 そもそも文書とは？ 英語だと document。ここで指す(技術)文書とは、人間が読む文体で書かれた技術に関連する情報、といったものだ。具体的に言うと以下の様なものを想定している: 新しいプロジェクトの骨子を説明する資料 会議の叩き台となる 1 枚ペラ 本番環境に変更を加えるにあたっての包括的な情報や具体
Old Brains - kuenishi's blog
そろそろ歳も40近くなり、老いについて考えることが増えてきた。たとえば10ヶ月も続く在宅勤務の中で少しでも運動をサボると左膝がすぐに痛みだしたり、うっかり水分を摂り忘れたりすると頭痛がきたりする。もちろん体重は史上ピークを記録し続けている。身体の老いについては、まあそういうものであるし、特に外見などに気を遣って生きてきたわけでもないからそんなには気にしていない。しかしながら、人間の人間たる由来はその精神や振る舞いにあると思っているから、そちらでの老いの方が問題だ。 前職までは大抵、わたし自身は年齢が1番か2番めくらいに若い職場で仕事をしていることがほとんどであった。ほとんど同年代か、10から20くらい上であることが多かったように思う。単に物理的な年齢もあるが、職業経験も私より長い人たちばかりであったので、教わることの方が多かったから、物事の考え方が揃っていたことが心地よかったということには
初めての「技術ブログ」書き方のご紹介 - SORACOM公式ブログ
技術ブログは「書く」というより「記す」というのがシックリきている、ソラコム松下(max)です 2017年3月にテック・エバとして活動を開始し、通算400回以上講演の他、ブログでも情報発信しています。 年間で20本以上のブログを書いてくるうちに、だんだんと書き方がわかってきました。ですので、今回は 技術ブログの書き方ブログ を紹介します！ 技術ブログは「未来の自分へのドキュメント」 技術ブログは普通のブログとは異なります。 未来の自分へのドキュメント です。 「あー、これ既にやったことあるなー。なんだっけ？」とググった先が自分のブログであってほしい、そんな思いで書いてみてください。一番最初の利用者が自分、すなわちドッグフーディングしましょう。これはサービス開発でも、ブログでも共通して言えることです。 もし、手元に「メモ的なテキスト」があるならば、それはブログにできるかもしれません。 まずはタ
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
