タグ

2017年1月20日のブックマーク (2件)

  • 【API Blueprintの使い方】Web APIの仕様書を書く・読む・実行する | DevelopersIO

    API Blueprintの使い方】Web APIの仕様書を書く・読む・実行する できればドキュメント書きたくないなー。はやくAPI実装したい!俺の頭の中に全部仕様入ってるから!俺が仕様だ! ... その仕様、API Blueprintでドキュメントにおこしませんか? はじめに デバイスが多様化し、その違いを吸収する統一的なインターフェースが求められる昨今、Web APIはその回答のひとつといえます。弊社でも、モバイルアプリとWeb APIを組み合わせてサービスを構築することがあります。 Web APIが登場する開発では、モバイルアプリ(APIクライアント)メンバーと、APIサーバメンバーのコミュニケーションが不可欠です。開発を円滑に進めるために、APIの仕様書 が必要になります。お互いがAPIの仕様を想像して勝手に開発を進めたのでは、いざ結合したときに悲惨な結果になることが目に見えてい

    【API Blueprintの使い方】Web APIの仕様書を書く・読む・実行する | DevelopersIO
  • ソフトウェアプロダクトを管理するときに考えること | ソフトウェア開発のメモ帳

    ソフトウェア開発チームの人数が増えると情報の整理方法が悩ましいので、網羅性はありませんが思いついたものを列挙しておきます。 ドキュメントを書く インフラを整える 開発環境を整備する 設定情報を管理する ドキュメントを書く そもそも何を実現するソフトウェアなのかがブレてしまうプロダクトもあると思いますので、 基的なことをしっかりと書いておくことは重要です。 基事項 目標 要件 (機能要件、非機能要件) 設計思想 仕様 (外部仕様、内部仕様) チームメンバーの入り口となる情報 ソースコード管理システムへのポインタ チケットなどのトラッカーへのポインタ 開発ロードマップとマイルストーン コミュニケーション・チャンネル (メール、チャット、ニュースレターなど) プロジェクトの用語集 - SQLAlchemy の場合 プロセスに関するドキュメント 開発全般に渡るワークフロー - mozilla.