+- JeuWeb - Crée ton jeu par navigateur (https://jeuweb.org)
+-- Forum : Discussions, Aide, Ressources... (https://jeuweb.org/forumdisplay.php?fid=38)
+--- Forum : Débuter et gérer son projet (https://jeuweb.org/forumdisplay.php?fid=60)
+--- Sujet : Écrire une documentation, quels outils ? (/showthread.php?tid=5425)
Pages :
1
2
Écrire une documentation, quels outils ? - niahoo - 14-05-2011
edit: pour les flemmards, la lecture des paragraphes d'intro est dispensable.
hello,
bon je suis depuis plus d'un an maintenant en train de concevoir un gameplay, une univers, une ambiance, etc. pour un jeu. ça paraît long mais je change d'avis souvent, et je ne note pas grand chose.
J'ai lu quelque part que l'on retient les bonnes idées sans avoir à les noter et j'avoue que j'avais déjà antérieurement adopté – inconsciemment – cette philosophie.
Donc un an, oui, mais un an assez court au final au vu de ce que j'en garde de bon. Je change beaucoup d'avis, notamment autour de l'univers, je suis parti d'un truc médiéval fantastique, pris un virage vers la préhistoire… quelques errements supplémentaires m'ont amené où j'en suis aujourd'hui.
Mais assez parlé de moi, si je vous parle de ça, c'est parce que si on retient les bonnes idées, on ne retient pas assez de détails techniques qui ont leur importance, et qui aident à déterminer si une idée est bonne.
Si dans mon jeu j'utilise des moteurs différents, l'un à l'essence, l'autre au gaz, l'autre à la vapeur+uranium, et que considère que c'est une bonne idée, j'ai quand même besoin de noter quelques détails. Actuellement je dois noter des formules mathématiques qui déterminent la puissance de ce genre de moteurs. C'est la formule mathématique finale que j'ai élaborée, qui est robuste et malléable à souhait, qui me fait penser auourd'hui que c'est une bonne idée. Seulement, sans la formule, l'idée redevient quelque chose de très bateau.
Malheureusement, je ne peux pas stocker ça publiquement car je ne veux pas que certaines formules soient visibles ; d'une part parce que si un jour d'autres personnes que moi jouent à mon jeu je préfèrerais que personne ne les retienne, histoire de masquer ça par quelque chose de plus hasardeux qui pousse à l'expérimentation, d'autre part parce que ce sera en quelque sorte « encapsulé » par des variables plus simples sur lesquelles il sera mieux de se baser, l'expérimentation précédente permettant de se fier de manière sure aux quelques données accessibles au joueur. (En gros, quand on te file un V12, tu sais que ta caisse va bien accélérer et aller vite, peu importe comment le moteur foncitonne à l'intérieur).
fin de l'intro
Donc bon, je raconte ma life (c'est pasque on a pris l'apéro là, ça rend loquace), j'aimerais surtout connaitre vos outils de prédilection pour écrire de la documentation.
J'ai besoin de quelque chose de simple, mais qui puisse être relu facilement avec une belle présentation à l'impression.
LaTeX c'est bien beau mais au final, le fond n'est pas du tout séparé de la forme comme on essaie de nous le faire croire. J'ai retenu markdown pour le moment, qui est simple à écrire, simple à lire et s'imprime facilement en HTML avec 3-4 règles de CSS sans plus.
Mais si vous avez mieux, c'est le but de ce post.
Ensuite, je dois versionner tout ça, j'ai parfois des changements d'avis qui demandent de supprimer quelques paragraphes, d'en ajouter d'autres, de changer certains concepts, etc, *mais* cela ne doit pas être public. Adieu github et consorts. (edit: pasque je suis radin, cf. ci-dessous)
Je n'ai pas confiance en moi quant au fait de faire des sauvegardes régulières, j'écris ce post en réaction à la perte de quelques 400 lignes de texte, (et pas du code) refermant quelques concepts plutôt intéressants dont certains seront à jamais perdus. (bon, c'était pas révolutionnaire mais ça fait chier quoi)
Évidemment, si ça pouvait être gratos ce serait vraiment super ! C'est ce que je cherche, un truc de gestion de version (git, svn, …) gratos, pas visible par tout le monde, et fiable surtout. Ouais je rêve un peu mais c'est jouable.
Bon, j'ai un peu cherché par moi-même, j'ai trouvé xp-dev, mais c'est galère leur inteface, j'ai pas tout saisi.
Donc voilà, qu'utilisez vous pour ce genre de trucs ? Êtes-vous confrontés au même problème ? Avez-vous résolu le problème en réfléchissant autrement ? Je pourrais bien faire tout par écrit – en fait, j'ai commencé comme ça – mais pour de la doc technique (rappelez-vous : concpets de base retenus uniquement dans la tête) c'est relou au vu des modifications régulières à apporter.
Hum, je sais pas si mon post est très clair…
merci
notez que je ne parle pas de code source dans ce post, mais le problème est exactement le même : si pour le code le choix de l'éditeur n'est pas gouverné par des besoins de présentation, d'impression, et donc reste un choix personnel trivial, l'importance d'une sauvegarde fiable, privée, et externalisée (comprendre « pas à la maison sur le vieux DD entre les mp3 et les films) reste un problème.
RE: Écrire une documentation, quels outils ? - Sephi-Chan - 14-05-2011
J'aime beaucoup Markdown également. En ce moment j'utilise Google pour mettre mes notes au propre.
Si tu veux un dépôt Git privé et gratuit, je te recommande d'utiliser Heroku.
C'est un usage détourné, mais ça le fait bien. 
RE: Écrire une documentation, quels outils ? - niahoo - 15-05-2011
ok, avant que j'aille voir, ça fonctionne comment ?
RE: Écrire une documentation, quels outils ? - Sephi-Chan - 15-05-2011
Plutôt pas mal.
RE: Écrire une documentation, quels outils ? - niahoo - 15-05-2011
cool mais ce que je voulais savoir c'est ce que je dois faire pour avoir ça. pasque la doc me parle de dynos et autres trucs chelous, mais j'ai du mal à cerner l'architecture générale de ce que je déploie.
En gros, c'est une plateforme pour applis rails c'est ça ?
RE: Écrire une documentation, quels outils ? - Sephi-Chan - 15-05-2011
Yes. Mais toi tu t'en fous. La seule chose qui importe pour toi, c'est l'installation de la gem puis la création de l'appli via la commande créée par la gem. Une fois que c'est fait tu as ton précieux repo privé pour pas un rond.
RE: Écrire une documentation, quels outils ? - niahoo - 15-05-2011
Mouais, je suis pas bien sûr d'avoir tout compris, mais je testerai, ça m'a l'air sympa.
RE: Écrire une documentation, quels outils ? - Sephi-Chan - 15-05-2011
Je te fais un petit topo.
Heroku est une plateforme d'hébergement en cloud pour des applications Ruby. Le système se charge de la partie Web : il sert les pages avec Nginx qui fait en plus office de reverse proxy (pour cacher les ressources statiques et/ou servies avec des headers de mise en cache) et de load balancer entre les machines virtuelles qui hébergent ton application (les dynos, que tu peux faire varier en nombre).
Quand tu push sur Heroku, il détecte les fichiers utiles à une application Ruby (config.ru et gemfile), installe les dépendances, etc. puis lance l'application.
Par défaut, ton application tourne sur un un unique dyno (qui est offert). Si tu as besoin de plus de puissance (que ce soit de manière permanente ou temporaire), tu peux demander d'autres dynos : ils sont alors facturés au prorata du temps pendant lequel tu les utilises (à la seconde près). Le désavantage de tourner sur un seul dyno, c'est qu'après 10 minutes d'inactivité, ton application est déchargée de la RAM, ce qui impliquera un chargement d'environ 5 secondes pour le prochain visiteur, m'enfin comme c'est gratos et que ça rend de fiers services, on ne s'en plaint pas. ^^
En plus de ces dynos, il y a les works, qui sont des processus qui te permettent de faire tourner des tâches à côté : très pratiques pour des système de queue et/ou de background jobs. Le mode de financement est le même que pour les dynos.
Le côté génial de ces workers/dynos, c'est donc que tu peux modifier les capacités de ton serveur à la volée très simplement. Tu peux le faire via la commande heroku installée sur ta machine mais également directement depuis ton application. Ainsi, si tu as besoin d'envoyer un tas de mails depuis ton application, tu peux activer un (ou plusieurs) workers, envoyer tes mails dans un processus séparé et désactiver le worker après l'envoi. Très économique ! :p
RE: Écrire une documentation, quels outils ? - Dexyne - 15-05-2011
Je me posais la même question, ça clarifie la chose, mais donc si c'est un hébergeur, quel niveau de "liberté" a-t-on pour la configuration de son hébergement justement, peut-on bien configurer selon nos souhaits ? C'est un hébergement comme Gandi (grosso modo niveau hébergement) ou rien à voir ?
Y'a l'air d'y avoir pas mal de services et de choses intéressante mais j'ai dû mal à comprendre le fonctionnement de leur(s) service(s).
RE: Écrire une documentation, quels outils ? - niahoo - 15-05-2011
Ok, je viens de trouver Pimki qui semble êtreun wiki à user unique fait avec Ruby. ça permetrait même de pas avoir à se faire ch.. avec git (sauf si la DB est payante)
Le truc, est-ce que Heroku va pas me jetter en voyant que je me sers d'eux comme un espace de stockage ?