Googleが開発者向け文書で使っていた英語スタイルガイドが社外に公開された（Googleブログ）。 URLはこちら： Google Developer Documentation Style Guide https://developers.google.com/style/ MicrosoftやIBMは自社の英語スタイルガイドを書籍（リンク：MS／IBM）として販売するしているし、Appleは公開（リンク）している。Googleもマテリアル・デザインの一部としてスタイルを公開してはいる（リンク）が、分量が少ないため、他社と比べるとどうしても見劣りした。 そのため、「開発者向け文書」を対象としてはいるものの、ある程度の規模のスタイルガイドが公開されたのは意義深い。 そこで今回は、同スタイルガイドの要点（highlight）のみについて読んでみたい。 Highlights https://
製品 { this.openCategory = category; const productMenu = document.querySelector('.product-menu'); window.DD_RUM.onReady(function() { if (productMenu.classList.contains('show')) { window.DD_RUM.addAction(`Product Category ${category} Hover`) } }) }, 160); }, clearCategory() { clearTimeout(this.timeoutID); } }" x-init=" const menu = document.querySelector('.product-menu'); var observer = new MutationO
最近のウェブ開発では各機能ごとをAPIでつなぎ込む時代になっています。 そのため、各チームが開発をしていく上で、 他のチームにAPIの仕様を伝える方法をきちんとまとめておく必要が出てきています。 そんな中でAPIドキュメントにどのような役割が求められていて どのような選択肢があるか、一旦自分の把握している知識をまとめています。 (ここで書いているAPIは、httpでアクセスしたら、JSON形式でレスポンスを返すウェブサービスのAPIを指しています) APIドキュメントを用意する上で、すぐにぶつかる壁 APIドキュメントを用意する場合に、何も考えずにExcelやwikiにまとめると、早い段階で メンテナンスのコスト の問題にぶつかります。 『APIドキュメントを書く時間がない』 『本当にドキュメント通りの結果が返ってくるか、試してみないとわからない』 『実際に返ってくるAPIとレスポンスが違
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く