Antichesse (o ^ω^ o)
@Gégé totalement d'accord avec toi ! Même remarque au sujet du man sous Linux. Si tu ne sais pas déjà ce dont tu as besoin, alors il ne te sera d'aucune utilité.
C'est un vrai problème d'une manière générale dans le monde du logiciel libre. Les documentations techniques internes au projet sont considérées comme des documentations utilisateurs. Comme s'il y avait un plaisir personnel à apprendre un truc ultra complexe pour une utilisation jetable. À chaque fois ça ce raisonnement me dépasse.
C'est l'un des rares reproches que je fais régulièrement à l'open source.
Ce qui est super c'est que la documentation possède un tableau comparant la complexité des différentes structures en fonction des cas d'utilisation.
Tout est dans le titre.
Il s'agit d'une traduction en français de la documentation / du livre disponible sur https://doc.rust-lang.org/stable/book/ et qui porte sur le langage Rust.
Cela devrait aider mes petits jeunes à mieux comprendre le langage. D'ailleurs je pense que je vais reprendre ma série de posts afin de synthétiser quelques concepts pour les néophytes.
Facile de répondre au besoin du comment avec du code. Je te rejoins sur le pourquoi et pour ce faire :
1) Relire Clean Code de Robert C. Martin.
2) Relire Object Thinking de David West.
3) Coder en FOP (function-object-programming).
4) N'avoir besoin de documenter que les interfaces afin de répondre au pourquoi.
5) Enjoy.
Je cite cette section car elle résume à elle seule l'intégralité du propos :
Tutorials
A tutorial:
- is learning-oriented
- allows the newcomer to get started
- is a lesson
Analogy: teaching a small child how to cook
How-to guides
A how-to guide:
- is goal-oriented
- shows how to solve a specific problem
- is a series of steps
Analogy: a recipe in a cookery book
Explanation
An explanation:
- is understanding-oriented
- explains
- provides background and context
Analogy: an article on culinary social history
Reference
A reference guide:
- is information-oriented
- describes the machinery
- is accurate and complete
Analogy: a reference encyclopaedia article
Via Tiger 222.
@Philou, merci pour ce lien, c'est exactement ce que je cherchais avec @Chlouchloutte ! La documentation sur l'écosystème Android.
Toute une liste de ressources expliquant ce qu'est le DDD.
Le lien le plus rapide : DDD Quickly.
C4-PlantUML combines the benefits of PlantUML and the C4 model for providing a simple way of describing and communicate software architectures [...]
Le doc c'est le code ! Ou pas... Le code ne peut pas exprimer le pour quoi ni le pour qui mais uniquement le quoi et le comment, de ce fait, il est nécessaire de documenter les intentions et la cible de l'application en plus de rédiger du code.
C4 était un bon modèle bien plus simple et bien moins coûteux qu'UML. Je ne connaissais pas PlantUML avant donc il faut voir.
Rappel : une bonne documentation explique le pour qui et le pour quoi en moins de 5 minutes.
Architecture Decision Record
Autre temps autre méthode. En résumé, quelles sont les bonnes pratiques de documentation dans un cadre agile.
La doc officielle de Sonatype à propos de la création de plugins.
La page contenant la documentation officielle de Gitea. Attention, celle-ci est un répo Git dans lequel des fichiers de conf sont fournis à titre d'exemple. Surprenant mais efficace.
Tout ce que vous devez savoir sur NPM notamment (dans la section CLI) la liste des paramètres de la ligne de commande
Nous en discutions avec Animal dans le train ce matin. Une JVM bien configurée permet de faire jusqu'à un fois10 en termes de performances. Cependant, les entreprises négliges systématiquement ces options.
En lien, la documentation officielle d'Oracle à ce sujet.
Tout est dans le titre.
Vous démarrez un projet, vous vous posez le choix de la techno, des outils de build, le dependencies manager, la software factory, software quality, le framework architectural, ce projet GitHub constitue une documentation complète sur l'ensemble des outils existant pour les 20 principaux langages (à cette heure, sûrement plus au fil du temps). Idéal pour savoir quoi prendre au lieu de démarrer sur les chapeau de roues.
Une site regroupant plein de documentations sur des technos web (mais pas que). Vraiment très bien fait, je suis conquise. C'est simple, c'est élégant, bref ça change du Linux man...