タグ

ドキュメントに関するSnowCaitのブックマーク (7)

  • 誰も教えてくれない「分かりやすく美しい図の作り方」超具体的な20のテクニック

    【追記】この記事をきっかけに、名著「ノンデザイナーズ・デザインブック」の20周年記念特典eBookの制作に協力させていただきました。詳しくはこちらを御覧ください。 ノンデザイナーズ・デザインブック20周年記念の特典に寄稿しました デザイナーである・なしに関わらず、仕事の中で伝えたいことを「図」で説明する機会は多々あります。提案書で事業内容を説明することもあるでしょうし、具体的な数値をグラフで説明することもあるでしょう。そんな中でこんな指摘を受けたことはありませんか? ・最終的に何を言いたいのか結論が見えないよ。 ・関係性が複雑すぎて理解しずらいんだけど。 ・要素が多すぎて全てを把握するのが大変。 ・何をどこから見れば良いの? ・結局一番言いたいことはなんなの? ・文字サイズがたくさんありすぎてまとまりがないね。 ・安っぽいチラシみたいでダサイなぁ。 ・全体的にバランスが偏ってて不安定。 ・

    誰も教えてくれない「分かりやすく美しい図の作り方」超具体的な20のテクニック
  • ドキュメント作成時のあるあるアンチパターン20 - Qiita

    業務でドキュメントを作成するケースは多々ある 例:仕様書・設計書・提案書・メール・障害票... ここでは各ドキュメント共通してありがちなアンチパターンをまとめてみました。 1. 表記がバイト表示・マイクロ秒表示 プログラムが出した数値をありのままに表示するパターン ファイルサイズが100MB, 1GBあろうと、バイト表示にする 桁数が多い数値に、桁区切り(,)を入れない 時間を何でもマイクロ秒・ミリ秒にする(1/100万秒までの精度が必要?体感で分かる?) 桁数が多い=精度が高い=良い文書、ではなく、見る人が必要とする精度に切り上げることが重要(売上で1円単位まで出すことが無いのと同様) 悪い例 No ファイル名 ファイルサイズ(byte) 処理時間(秒)

    ドキュメント作成時のあるあるアンチパターン20 - Qiita
  • APIドキュメントを書くのが楽になるツールまとめ - Qiita

    さいきんREST APIのドキュメントを書いていて、wiki使うのだるいし他に良い方法ないかな〜と調べてた時に見つけたツール群をまとめてみます。 追記: こちらも便利そうなので参考にどうぞ。 REST APIドキュメント作成ツールはapiary.ioが決定版かもしれない - Qiita swagger Swagger: A simple, open standard for describing REST APIs with JSON | Reverb for Developers デモ: Swagger UI ソースコード中にAPIの概要を書いておくと、それを元にドキュメントを自動生成してくれる。wikiやmarkdownで書くのと決定的な違いは、↓のようにドキュメント上のformからAPIコールを試すことができる点。 様々な言語のWAFに対応したライブラリも開発されてる。 Home ·

    APIドキュメントを書くのが楽になるツールまとめ - Qiita
  • Welcome to Mobage Japan - Welcome - Mobage Developers Documentation Center

    このドキュメントは Mobage Japan へゲームをリリースする場合のドキュメントです。他のリージョンへ配信する場合は、上部より配信エリアを選択の上、ご覧ください。 Mobage オープンプラットフォームとは、デベロッパー様が開発したアプリケーションを Mobage、Yahoo! Mobage に公開できるよう、プラットフォームを提供するサービスです。 デベロッパー様は、Mobage オープンプラットフォームが提供する API を介して、Mobage、Yahoo! Mobage のユーザのデータやソーシャルグラフにアクセスすることができます。 また、仮想通貨であるモバコインを通じてユーザは課金することができます。 現在、このサイトでは以下の技術ドキュメントと FAQ を公開し、アプリケーション開発をサポートしています。 Next Browser Platform (NBPF) 版ドキュ

  • Documentation - Evernote Developers

    API Documentation Multiple ways of connecting to the Evernote service Evernote provides two main APIs that you can integrate into your applications: the Local API and the Cloud API. When you access the Local API, your application is interacting with a local Evernote client such as Evernote for Mac or Evernote for Android. When you access the Cloud API, you're speaking directly to the Evernote web

  • Laravel:Web職人のためのフレームワーク

    Laravelドキュメント 初めに Laravelを楽しめるのは誰? Laravelはどこが違うの? アプリケーション構造 Laravelのコミュニティー ライセンス情報 初めに Laravelのドキュメントへようこそ。 このドキュメントはスタートガイドとして、さらに特徴の紹介としても役立つように書かれています。 どこから読んでも学習できますが、以前に学んだ概念をもとに、その後に続くドキュメントは書かれていますので、初めから順番に読むことをお勧めします。 Laravelを楽しめるのは誰? Laravelは柔軟性と読み書きしやすさを重視した、パワフルなフレームワークです。 初めてLaravelに触れる方は、人気がある軽量なPHPフレームワークを使用して開発する時と同じ、安らぎを感じるでしょう。 もうちょっと経験を積んだユーザーであれば、他のフレームワークではできない方法で、コードをモジュール

  • FuelPHP ドキュメント

    FuelPHP へようこそ FuelPHP はシンプルで、フレキシブルな、コミュニティにより開発されている PHP 5 用の Web フレームワークです。現在のフレームワークに対する不満から産まれ、開発者のコミュニティからサポート、支持されています。 FuelPHP はとても移植性が高く、多くのサーバで動き、そして、とても綺麗な構文のフレームワークです。 クイックインストール もしあなたが今すぐに Fuel を試したいと思うなら、高速インストーラを使ってみてください。curl ライブラリを使用し、oil の必要最小限のバージョンをインストールできます。それから、Fuel の新しい完全なアプリケーションを作成できます。 # oil を Web からクイックインストールします $ curl get.fuelphp.com/oil | sh # oil が、たった今、インストールされました。Si

  • 1