Jeffrey Cross
Jeffrey Cross

Comment écrire un hack pour O'Reilly

[Remarque: ceci a été initialement publié sur le réseau O’Reilly le 30 août 2005.]

En tant que rédacteur en chef de la série O’Reilly’s Hacks, j’ai quotidiennement à traiter des propositions de livres pour Hacks. J'ai aussi généralement plusieurs livres à divers stades d'acquisition, d'écriture ou de production, qui ont bien sûr tous des auteurs et (ceci étant Hacks) de nombreux contributeurs. Au-delà des questions sur les domaines d’activités sur lesquels nous souhaitons publier, les questions les plus fréquentes sont généralement des variations sur le thème de ce qui fait un bidouillage et comment on devrait être écrit.

Je souhaite depuis longtemps écrire quelque chose pour les auteurs, les contributeurs et les autres rédacteurs actuels et futurs de O'Reilly (à partager avec leurs auteurs) qui explique exactement ce que nous entendons par «une solution non évidente à un problème intéressant». Mais bien sûr , Je n’ai pas eu le temps de le faire, alors j’essaie souvent d’expliquer quelque chose qui, quand il s’agit de faire quelque chose, nécessite de s’enfuir. Malheureusement, après quelques tentatives pour mettre un terme au terme pirater (utilisé par O’Reilly), j’utilise souvent une description qui ne vaut guère mieux que la fameuse définition de l’obscénité donnée par le juge Stewart: "Je le sais quand je le vois."

Aujourd’hui, je discutais d’un nouveau projet avec Paul Bausch, qui s’est imposé comme auteur modèle de la série (notamment Amazon Hacks, la prochaine Yahoo! Hacks, un troisième titre Hacks non encore annoncé, Flickr Hacks et Google Hacks, troisième édition), et j’ai appris qu’il avait tranquillement rédigé sa propre version de ce thème. Paul est un auteur qui utilise le format Hacks avec peu de besoin de supervision ou d’orientation. J’étais donc particulièrement intéressé par son point de vue. Il n’a pas déçu, alors je lui ai demandé de partager ses conseils avisés avec le monde entier. Heureusement, il a accepté. Voici ce qu’il décrit comme son Modèle de piratage:

Je considère un hack comme un projet que le lecteur peut accomplir. Le lecteur doit également savoir pourquoi il souhaite réaliser le projet et avoir une idée de ce à quoi devrait ressembler le projet une fois terminé. Voici mon modèle:

  1. Pourquoi ce hack est-il nécessaire (histoire, construction du désir)
  2. Décrivez les caractéristiques pertinentes
  3. Prérequis de piratage
  4. Code de piratage / procédure
  5. Exemple de piratage en action
  6. Bref résumé (pourquoi le lecteur déchire!)

  7. Si possible, alternatives de piratage

Dans la mesure du possible, j'utilise les rubriques classiques du code et du code d'exécution du hack pour séparer les parties 4 et 5. Le chapitre "Pirater le hack" de la partie 7.

Le reste de son poste expose plus en détail sa philosophie et son approche. Bien qu'il y ait certainement des choses que j'ajouterais si le temps le permettait, et que d'autres points de vue et approches sont certainement les bienvenus (Hacks contient des multitudes: il a toujours de la place pour une variété de points de vue et embrasse la diversité d'opinions et d'approches), l'explication de Paul et ses conseils sont aussi bien que j'aurais pu l'espérer.

Si vous envisagez d’écrire pour la série Hacks, écrivez-nous actuellement, ou si vous voulez simplement jeter un coup d’œil sur les coulisses de la fabrication de la saucisse, vous ne voudrez certainement pas la manquer.

Part

Laisser Un Commentaire