なぜこのブログを書こうと思ったか？ 📝 とある1on1で「テックブログってどうやって書いているんですか？」と聞かれたのが発端です。 自分は数ヶ月に1記事くらいの頻度で執筆しており、その過程をあらためて言語化して社内に展開したところ、意外とポジティブな反応をもらえたのでブログにも書き起こしてみました。 皆さんの執筆の後押しになれば幸いです🙆 そもそもなぜテックブログを書くのか？ 🤔 自分の場合、以下の3つの理由でテックブログを書いています。（上から重視している順に並んでいます） 思考の整理&深掘り 文章を書く練習 対外的なアピール 理由その1: 思考の整理&深掘り 1つ目の理由としては、記事を書くことで思考を整理したい意図があります。 たとえば「こういう事象やバグを改善した」という内容のブログを書くときに、「どうやってその事象やバグを改善したのか」については書くと思います。その過程で
一番身近に聞くであろう単語で分類しました。この記事は何らしらのデバイス(iOSアプリ/Androidアプリ/ブラウザ)で見ていると思いますがそれらをフロントエンドと呼びます。ユーザにとってアプリであろうがブラウザであろうがサイトが見れて使えれば問題ないですがエンジニアにとっては明確に違います。それぞれ異なったプログラミング言語で異なった思想のもと作られたデバイスで動かす必要があります。そのためフロントエンドエンジニアといってもiOSエンジニア、Androidエンジニア、フロントエンドエンジニア(ブラウザ用のフロントエンドを開発するエンジニアをこう呼ぶことが多い気がします)と分けて募集することが多いです。 異なったデバイスのために最低でも3人のエンジニアを採用するのは大変です。そのため1つのプログラミング言語で開発できればプロダクト開発が早まりそうです。そのような技術としてはFlutter,
最近知った興味深いPodcast e34.fm で紹介されていたので興味を持って読んでみた本「Docs for Developers: An Engineer’s Field Guide to Technical Writing」に関するメモ。 2023/3追記：翻訳されたようだ。ユーザーの問題解決とプロダクトの成功を導く エンジニアのためのドキュメントライティング e34.fmwww.oreilly.com この記事の目次 「Docs for Developers」はどんな本なのか 全般的な感想 各章に関する覚え書き Front Matter Chap 1. Understanding your audience Chap 2. Planning your documentation Chap 3. Drafting documentation Chap 4. Editing docum
TL;DR 技術記事を書いて公開してくれる人は貴重な資源なので、なるべく潰さないように大事にしましょう。 はじめに プログラムを書いてて、なにかわからないことがあれば検索すると思います。すると、世の中にはごく少数の役に立つ記事と、大多数の役に立たない記事があることがわかるでしょう。その役に立つ記事を求めてネットの海をさまよっていると、「あれ？またこの人の記事だ」と思うことがよくあるでしょう。C++の言語仕様を調べてると「あの人」の、Vim関連を調べていると「あの人」の、Go言語なら「あの人」の記事を見つけることでしょう。逆に言えば、ある程度限定された分野において、体系だった知識があり、わかりやすい記事を書いてくれる人というのは極めて貴重な人材ということになります。 しかし、そんな「つよつよエンジニア」も、はじめから強かったわけではありません。当然のことながら新人時代があり、よくわかっていな
「公式ドキュメントを読め」というのが急に話題になっていたので自分なりに整理してみました。 注意: そんなに真面目に推敲していません。フィーリングで書いているので実態に即してない部分もあるかも…… 公式ドキュメントとは何か あなたが使おうとしている道具 (ライブラリ、フレームワーク、プログラミング言語、ミドルウェア、コマンドラインツール、etc.)[1] は必ず誰かによって作られています。ある程度成熟した道具であれば通常、その作った人・組織自身によって公開されているドキュメントがあるはずです。これが公式ドキュメントです。 公式ドキュメントは、OSSにおいてはソースコードと双璧をなす最も信頼できる資料のひとつです。ソースコードが非公開の場合は通常、公式ドキュメントが最も信頼できる資料でしょう。 (以降はOSSを主に想定して説明します) たとえば…… Python のソースコードはGitHub上
Homepage Please support this book: buy it or donate (Ad, please don’t block.) Deep JavaScript Table of contents
この記事は、著者の許可を得て配信しています。 Why programmers don’t write documentation 最近ではずっとコードのドキュメンテーションに関連した記事を書いていたので、当然、私のMediumのおすすめ記事には「開発者がドキュメントを書かない本当の理由」という記事が表示されるようになりました。この記事では、ドキュメントを書くための優れたツールがないことが、ソフトウェアエンジニアが自分の作業や判断をドキュメンテーションする意欲を失わせる最大の原因について書いています。 私は普段、特定の記事を批判したりはしませんが、この記事には怒りを覚えました。このライターは図解ツールについていくつかメリットに関して述べてはいますが、全体的に誤解を招くような内容になっており、この重要な問題をより分かりにくくさせています。2つの図解ツールを比較して、どちらも不十分なツールである
はじめに 飲み物じゃないIPAをご存じでしょうか？ 漢字でいうと、独立行政法人 情報処理推進機構ですね。情報処理技術者試験を実施いる謎の組織という認識の方も多いと思います。 実はIPAはいろんなドキュメントを公開していてQiitaやZenn以上にお役立ちなサイトなのです。 まあ、AWSをどうこうとか、FireabaseやNext.jsのようなキラキラした奴は基本載ってないので特に代替えするものではないですが、ブログとかはまた種類の違った情報があるので個人的には結構使うことあります。しかも 「日本語」！ こういう感じの事をTwitterでつぶやいたところ意外にイイねをされたので、せっかくだしどんなドキュメントがあるかちょっと紹介したいと思います。 セキュリティ関連NIST文書 まずはNISTドキュメントの翻訳版！ これは良いですよね。NISTはアメリカの米国国立標準技術研究所で、セキュリティ
本書『サバイバルTypeScript』は実務でTypeScriptを使う開発者のための入門書です。そして、このページはTypeScriptの特徴を最速で把握できるよう、数百ページからなる本書のコンテンツをつまみ食いした要約です。 » 本書について詳しく知る » とにかく今すぐTypeScriptを書いてみたい TypeScriptとはJavaScriptのスーパーセットとなるプログラミング言語。静的型付け言語であり、プログラムの正しさが静的に検査できる。ライブラリやIDEなどの開発環境が充実しており、大きなエコシステムを持っている。Microsoftが2012年に開発し、オープンソースで公開した。» TypeScriptの特徴について詳しく知る » TypeScript誕生の背景について詳しく知る TypeScriptはJavaScriptのスーパーセットスーパーセットとは、元の言語と
概要 PHPプログラミングの世界では、ある一定のトレンドが「モダンPHP」として、一部の人によって (彼らの書籍やウェブサイト上で) 強烈に広められ、他のアプローチは、遅れていたり、愚かだったり、あるいは単に間違いだとみなされて、眉をひそめられています。 それらの人々は、彼らの物事のやり方を他人に追従させようと、飽くなき努力を続けているように見えます。 このウェブサイトは、PHP プログラミングに関する現実的な見解を示すために作られました。流行りのトレンド、理論、学問的な教示ではなく、経験と実践の帰着を書き記した視点です。 ウェブサイト PHP - The Wrong Way は生きたドキュメントですので、より多くの情報が明らかになるにしたがって更新され続けます。 お気軽にコントリビュートしてください。 翻訳 ドイツ語 英語 フランス語 日本語 インドネシア語 トルコ語 ペルシャ語 ポルト
Google が提供するさまざまなAPI やツールの詳細な技術情報は、すべて Google Code で公開されています。しかし、全ての技術情報は英語で記されていたため、多くの日本のデベロッパーからは技術ドキュメントを日本語化して欲しいとの要望をいただいていました。 そこで、 開発者ホーム と題して Google Code の日本語版の運用を開始しました。4月より、2 つの技術、OpenSocial と YouTube Data API の技術ドキュメントの日本語版の提供を開始しました。そして、Google Developer Day 2008 Japan の開催にあわせ、さらに多くのドキュメントと映像を日本語化しました。 本日、日本語版が公開されたドキュメントおよび映像は以下となります。 OpenSocial YouTube Data API Google Gadgets API Goo
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く