3WDOC, jQuery, HTML5, SaaS – La première version de la documentation de l’API 3WDOC

by Posted on

3WDOC, jQuery, HTML5, SaaS - La première version de la documentation de l'API 3WDOCCopyright © 3WDOC

Comme souvent lorsque on conçoit un SaaS, une application en ligne, on se doit de publier une documentation notamment sur l’API (Application Programming Interface ou API) qui fait vivre ce webservice. C’est aujourd’hui chose faite, c’est une première mouture ou une première version qui donne à voir les principes constitutifs et applicatifs qui sous-tendent notamment le player pour une utilisation plus avancée de 3WDOC.

Documenter une API, c’est écrire en franglish, parce que parfois, tout est trop compliqué de traduire parce déjà si dur à concevoir. Toutefois, lire la documentation d’une API peut-être un festin de ROI. Deux citations pour étayer ce propos.

“Je voudrais être un agitateur pour les réguliers, et parvenir à ce qu’on laissât s’exprimer les irréguliers.”

— Michel Foucault

“We are much better at writing code than haiku.”
— Matt Mullenweg, founder of Automattic

Comment se structure la documentation

Rien de dépaysant, on y retrouve donc :

  1. Getting started (french)
  2. Player API methods (english)
  3. Player API events (english)
  4. Player API definitions (english)

Les ultimes recommandations pour une bonne lecture

Pour commencer il vous faut:

  • être familiarisé un minimum avec HTML5, CSS2.1+, Javascript, jQuery, jQuery-ui
  • comprendre le principe de l’embed dans une page web.
  • posséder un compte 3WDOC Studio en activité, si vous n’en avez pas encore, inscrivez-vous c’est gratuit!
  • une console de debug Javascript dans un navigateur web HTML5 sur un ordinateur qui n’a pas plus de cinq ans, nous conseillons vivement Google Chrome, Firefox avec Firebug peut aussi faire l’affaire même si nous constatons des performances inférieures à celles de Chrome.
  • un éditeur de code source avec colorisation syntaxique ou même un éditeur de texte brut.
  • un bon siège (sisi c’est important!)

Plus d’informations

Published by Bruno Flaven

By now, Bruno Flaven works as AI Coordinator. He has been a project manager in a wide variety of Internet business applications both in Mobile and in Desktop for 20 years now. You can find more information about his professional life on his personal website (www.flaven.fr) or his linkedin profile: https://www.linkedin.com/in/brunoflaven. He is currently working In France Media Monde (FMM) mostly on mobile applications (iOS and Android). He has also worked as P.O for a Backoffice project made with Symfony. He also made few trainings to facilitate the handling of the tools that he helps to make.

Related Posts