{"id":41,"date":"2026-05-14T18:39:32","date_gmt":"2026-05-14T22:39:32","guid":{"rendered":"http:\/\/localhost\/testwiki\/2026\/05\/14\/2-3-documentation-incluse-readme\/"},"modified":"2026-06-11T03:57:34","modified_gmt":"2026-06-11T07:57:34","slug":"2-3-documentation-incluse-readme","status":"publish","type":"knowledgebase","link":"https:\/\/aparadis.dectim.ca\/testwiki\/wiki-normes-standards\/normes-transversales\/2-3-documentation-incluse-readme\/","title":{"rendered":"2.3. Documentation incluse (README)"},"content":{"rendered":"<p>La documentation sur un projet doit \u00eatre plac\u00e9e dans un fichier <strong>README.md (fran\u00e7ais)<\/strong> \u00e0 la racine du dossier de projet (ou du d\u00e9p\u00f4t GitHub).<\/p>\n<p><a href=\"https:\/\/drive.google.com\/file\/d\/1hogLjXWToqOhxF4rYVdAKUOKE13F0COT\/view?usp=drive_link\" target=\"_blank\" rel=\"noopener\">Un mod\u00e8le de README pour modifier est disponible ici<\/a>.<\/p>\n<h2><strong>2.3.1. La documentation doit inclure :<\/strong><\/h2>\n<p><strong>R\u00e9sum\u00e9<\/strong><\/p>\n<ul>\n<li>Un paragraphe court et descriptif qui introduit le projet<\/li>\n<\/ul>\n<p><strong>Captures d&rsquo;\u00e9cran<\/strong><\/p>\n<ul>\n<li>2 \u00e0 4 images<\/li>\n<li>R\u00e9solution id\u00e9ale 1920 x 1080 px, format png ou jpg<\/li>\n<\/ul>\n<p><strong>Nom de l&rsquo;\u00e9l\u00e8ve<\/strong><\/p>\n<p><strong>Pour les travaux d&rsquo;\u00e9quipe<\/strong><\/p>\n<ul>\n<li>Le nom des membres de l&rsquo;\u00e9quipe<\/li>\n<li>Inclure une adresse de contact par personne (ex. courriel institutionnel ou professionnel)<\/li>\n<\/ul>\n<p><strong>Logiciel(s) utilis\u00e9(s)<\/strong><\/p>\n<ul>\n<li>Toujours nommer la version; ex. Unreal Engine 5.6.1<\/li>\n<\/ul>\n<p><strong>Cr\u00e9dits (essentiels pour les ressources externes utilis\u00e9es)<\/strong><\/p>\n<ul>\n<li>Citation avec le nom de la source, lien pour la source, type de licence et droits d&rsquo;auteur.<\/li>\n<\/ul>\n<p><strong>Cours et date de cr\u00e9ation (ann\u00e9e et session).<\/strong><\/p>\n","protected":false},"excerpt":{"rendered":"<p>La documentation sur un projet doit \u00eatre plac\u00e9e dans un fichier README.md (fran\u00e7ais) \u00e0 la racine du dossier de projet (ou du d\u00e9p\u00f4t GitHub). Un mod\u00e8le de README pour modifier est disponible ici. 2.3.1. La documentation doit inclure : R\u00e9sum\u00e9 Un paragraphe court et descriptif qui introduit le projet Captures d&rsquo;\u00e9cran 2 \u00e0 4 images [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","template":"","knowledgebase_cat":[6],"class_list":["post-41","knowledgebase","type-knowledgebase","status-publish","hentry","knowledgebase_cat-normes-transversales"],"_links":{"self":[{"href":"https:\/\/aparadis.dectim.ca\/testwiki\/wp-json\/wp\/v2\/knowledgebase\/41","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/aparadis.dectim.ca\/testwiki\/wp-json\/wp\/v2\/knowledgebase"}],"about":[{"href":"https:\/\/aparadis.dectim.ca\/testwiki\/wp-json\/wp\/v2\/types\/knowledgebase"}],"author":[{"embeddable":true,"href":"https:\/\/aparadis.dectim.ca\/testwiki\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/aparadis.dectim.ca\/testwiki\/wp-json\/wp\/v2\/comments?post=41"}],"version-history":[{"count":30,"href":"https:\/\/aparadis.dectim.ca\/testwiki\/wp-json\/wp\/v2\/knowledgebase\/41\/revisions"}],"predecessor-version":[{"id":674,"href":"https:\/\/aparadis.dectim.ca\/testwiki\/wp-json\/wp\/v2\/knowledgebase\/41\/revisions\/674"}],"wp:attachment":[{"href":"https:\/\/aparadis.dectim.ca\/testwiki\/wp-json\/wp\/v2\/media?parent=41"}],"wp:term":[{"taxonomy":"knowledgebase_cat","embeddable":true,"href":"https:\/\/aparadis.dectim.ca\/testwiki\/wp-json\/wp\/v2\/knowledgebase_cat?post=41"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}