{"id":11889,"date":"2018-04-05T08:13:48","date_gmt":"2018-04-05T12:13:48","guid":{"rendered":"http:\/\/www.analystik.ca\/blogue\/?p=11889"},"modified":"2019-04-18T15:30:19","modified_gmt":"2019-04-18T19:30:19","slug":"format-documentation-projet-ti-meilleures-pratiques","status":"publish","type":"post","link":"https:\/\/analystik.ca\/blogue\/language\/fr\/format-documentation-projet-ti-meilleures-pratiques\/","title":{"rendered":"Format de documentation d\u2019un projet TI; meilleures pratiques"},"content":{"rendered":"<p>Quel est le format de documentation d&rsquo;un projet TI le plus appropri\u00e9 ?\u00a0 Et quelles sont les meilleures pratiques de documentation d\u2019un projet TI en termes de format ?<\/p>\n<p>La question peut para\u00eetre \u00e9trange car pour plusieurs, cette question ne se pose m\u00eame pas. Mais en y regardant de plus pr\u00e8s, elle m\u00e9rite qu\u2019on s\u2019y attarde; comment doit-on documenter un projet TI et avec quel type de format ?<\/p>\n<p>Pour mettre en lumi\u00e8re le d\u00e9fi du format de documentation d&rsquo;un Projet TI, il faut tenir compte de trois facteurs\u00a0:<\/p>\n<ul>\n<li>Objet de la documentation<\/li>\n<li>\u00c0 qui elle s\u2019adresse ?<\/li>\n<li>Par qui est-elle produite ?<\/li>\n<\/ul>\n<p><!--more--><\/p>\n<h2>Quel est le format de documentation d\u2019un projet TI le plus appropri\u00e9 et\u00a0quelles sont les meilleures pratiques de documentation ?<\/h2>\n<p>R\u00e9pondre \u00e0 cette question n\u2019est pas si simple car sans \u00eatre infinis, les formats potentiels de documentation d&rsquo;un Projet TI potentiels sont nombreux\u00a0:<\/p>\n<ul>\n<li>Fichier Word<\/li>\n<li>Fichier Excel<\/li>\n<li>Fichier Visio<\/li>\n<li>Fichier Enterprise Architect<\/li>\n<li>Fichier RTF<\/li>\n<li>Fichier Markdown<\/li>\n<li>Fichier Balsamic Mockup<\/li>\n<\/ul>\n<p>Chez Analystik, nous utilisons tous ces diff\u00e9rents formats, voici pourquoi.<\/p>\n<p>&nbsp;<\/p>\n<p><strong>Fichier Word et Excel<\/strong><\/p>\n<p>Certains documents doivent \u00eatre partag\u00e9s avec les clients, c\u2019est le cas, par exemple, des comptes-rendus de r\u00e9union, des requis et de la documentation fonctionnelle.\u00a0 Nous utilisons donc pour ces documents un format accessible par tous; Word.<\/p>\n<p>Quant au format Excel, nous l\u2019utilisons syst\u00e9matiquement pour compiler les \u00ab\u00a0to-dos\u00a0\u00bb suite \u00e0 une r\u00e9union et pour des cas particuliers comme la d\u00e9finition et la documentation fonctionnelle d\u2019un algorithme complexe.<\/p>\n<p>&nbsp;<\/p>\n<p><strong>Fichier Visio<\/strong><\/p>\n<p>Malgr\u00e9 le fait que les capacit\u00e9s du logiciel Enterprise Architect sont plus \u00e9volu\u00e9s, nous avons d\u00e9cid\u00e9 chez Analystik d\u2019utiliser Visio pour sa simplicit\u00e9 et sa plus grande diffusion.\u00a0 Nous l\u2019utilisons pour sch\u00e9matiser des processus et pour cr\u00e9er nos diagrammes UML.<\/p>\n<p>&nbsp;<\/p>\n<p><strong>Fichier Markdown<\/strong><\/p>\n<p>Pour la documentation technique qui implique g\u00e9n\u00e9ralement l\u2019ensemble de l\u2019\u00e9quipe de d\u00e9veloppement, nous sommes pass\u00e9 du format RTF au format Markdown car ce format est de plus en plus standard et les \u00e9diteurs sont de plus en plus performants.\u00a0 Les avantages de ce dernier est le versionning (l\u2019outil d\u2019\u00e9dition conserve l\u2019historique des versions) qu\u2019il procure et la comparaison des versions.<\/p>\n<p>Ces deux formats, utilis\u00e9s \u00e0 l\u2019int\u00e9rieur d\u2019un environnement de d\u00e9veloppement comme Team Foundation Server (Team Service), g\u00e8rent bien les check-in &amp; check-out et permettent donc une \u00e9dition facile par de multiples usagers.<\/p>\n<p>&nbsp;<\/p>\n<p><strong>Fichier Balsamic Mockup<\/strong><\/p>\n<p>Dans le cas de Balsamic, je dirais que c\u2019est une histoire d\u2019amour chez Analystik.\u00a0 Il fait une seule chose mais il la fait tellement bien et tellement facilement.\u00a0 Il nous permet de faire les maquettes d\u2019\u00e9cran qui seront incluses dans notre documentation fonctionnelle.<\/p>\n<p>&nbsp;<\/p>\n<p><strong>CONCLUSION<\/strong><\/p>\n<p>Dans ce billet, nous avons d\u00e9crit comment nous documentons chez Analystik.\u00a0 Dans notre prochain billet, le troisi\u00e8me et dernier de la s\u00e9rie, nous parlerons de la fa\u00e7on dont nous sauvegardons toute cette information.<\/p>\n<p>&nbsp;<\/p>\n<p>Bon projet de D\u00e9veloppement,<\/p>\n<p>&nbsp;<\/p>\n<p><strong>Denis Paul &amp; Michel<\/strong><\/p>\n<!-- AddThis Advanced Settings generic via filter on the_content --><!-- AddThis Share Buttons generic via filter on the_content -->","protected":false},"excerpt":{"rendered":"<p>Quel est le format de documentation d&rsquo;un projet TI le plus appropri\u00e9 ?\u00a0 Et quelles sont les meilleures pratiques de documentation d\u2019un projet TI en termes de format ? La question peut para\u00eetre \u00e9trange car pour plusieurs, cette question ne se pose m\u00eame pas. Mais en y regardant de plus pr\u00e8s, elle m\u00e9rite qu\u2019on s\u2019y&#8230;  <a class=\"excerpt-read-more\" href=\"https:\/\/analystik.ca\/blogue\/language\/fr\/format-documentation-projet-ti-meilleures-pratiques\/\" title=\"Read Format de documentation d\u2019un projet TI; meilleures pratiques\">Read more &raquo;<\/a><!-- AddThis Advanced Settings generic via filter on wp_trim_excerpt --><!-- AddThis Share Buttons generic via filter on wp_trim_excerpt --><\/p>\n","protected":false},"author":3,"featured_media":11902,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_seopress_robots_primary_cat":"","_seopress_titles_title":"Format de documentation d\u2019un projet TI; meilleures pratiques","_seopress_titles_desc":"Quel est le format de documentation d'un projet TI le plus appropri\u00e9 ?\u00a0 Et, quelles sont les meilleures pratiques de documentation d\u2019un projet TI ? En y regardant de plus pr\u00e8s, elle m\u00e9rite qu\u2019on s\u2019y attarde; comment doit-on documenter un projet TI et avec quel type de format ?","_seopress_robots_index":"","content-type":"","footnotes":""},"categories":[3565,3377],"tags":[4418,4416,4412,4414],"better_featured_image":{"id":11902,"alt_text":"","caption":"","description":"","media_type":"image","media_details":{"width":2880,"height":1800,"file":"2018\/04\/typededoc-2.jpg","sizes":{"thumbnail":{"file":"typededoc-2-63x63.jpg","width":63,"height":63,"mime-type":"image\/jpeg","source_url":"https:\/\/analystik.ca\/blogue\/wp-content\/uploads\/2018\/04\/typededoc-2-63x63.jpg"},"medium":{"file":"typededoc-2-300x188.jpg","width":300,"height":188,"mime-type":"image\/jpeg","source_url":"https:\/\/analystik.ca\/blogue\/wp-content\/uploads\/2018\/04\/typededoc-2-300x188.jpg"},"medium_large":{"file":"typededoc-2-768x480.jpg","width":768,"height":480,"mime-type":"image\/jpeg","source_url":"https:\/\/analystik.ca\/blogue\/wp-content\/uploads\/2018\/04\/typededoc-2-768x480.jpg"},"large":{"file":"typededoc-2-1024x640.jpg","width":1024,"height":640,"mime-type":"image\/jpeg","source_url":"https:\/\/analystik.ca\/blogue\/wp-content\/uploads\/2018\/04\/typededoc-2-1024x640.jpg"},"bones-thumb-2880":{"file":"typededoc-2-2880x1800.jpg","width":2880,"height":1800,"mime-type":"image\/jpeg","source_url":"https:\/\/analystik.ca\/blogue\/wp-content\/uploads\/2018\/04\/typededoc-2-2880x1800.jpg"},"bones-thumb-1920":{"file":"typededoc-2-1920x1271.jpg","width":1920,"height":1271,"mime-type":"image\/jpeg","source_url":"https:\/\/analystik.ca\/blogue\/wp-content\/uploads\/2018\/04\/typededoc-2-1920x1271.jpg"},"bones-thumb-1536":{"file":"typededoc-2-1536x1016.jpg","width":1536,"height":1016,"mime-type":"image\/jpeg","source_url":"https:\/\/analystik.ca\/blogue\/wp-content\/uploads\/2018\/04\/typededoc-2-1536x1016.jpg"},"bones-thumb-960":{"file":"typededoc-2-960x635.jpg","width":960,"height":635,"mime-type":"image\/jpeg","source_url":"https:\/\/analystik.ca\/blogue\/wp-content\/uploads\/2018\/04\/typededoc-2-960x635.jpg"},"bones-thumb-600":{"file":"typededoc-2-600x397.jpg","width":600,"height":397,"mime-type":"image\/jpeg","source_url":"https:\/\/analystik.ca\/blogue\/wp-content\/uploads\/2018\/04\/typededoc-2-600x397.jpg"},"bones-thumb-300":{"file":"typededoc-2-300x199.jpg","width":300,"height":199,"mime-type":"image\/jpeg","source_url":"https:\/\/analystik.ca\/blogue\/wp-content\/uploads\/2018\/04\/typededoc-2-300x199.jpg"},"post-thumbnail":{"file":"typededoc-2-125x125.jpg","width":125,"height":125,"mime-type":"image\/jpeg","source_url":"https:\/\/analystik.ca\/blogue\/wp-content\/uploads\/2018\/04\/typededoc-2-125x125.jpg"}},"image_meta":{"aperture":"0","credit":"","camera":"","caption":"","created_timestamp":"0","copyright":"","focal_length":"0","iso":"0","shutter_speed":"0","title":"","orientation":"0","keywords":[]}},"post":11894,"source_url":"https:\/\/analystik.ca\/blogue\/wp-content\/uploads\/2018\/04\/typededoc-2.jpg"},"_links":{"self":[{"href":"https:\/\/analystik.ca\/blogue\/wp-json\/wp\/v2\/posts\/11889"}],"collection":[{"href":"https:\/\/analystik.ca\/blogue\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/analystik.ca\/blogue\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/analystik.ca\/blogue\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/analystik.ca\/blogue\/wp-json\/wp\/v2\/comments?post=11889"}],"version-history":[{"count":8,"href":"https:\/\/analystik.ca\/blogue\/wp-json\/wp\/v2\/posts\/11889\/revisions"}],"predecessor-version":[{"id":12016,"href":"https:\/\/analystik.ca\/blogue\/wp-json\/wp\/v2\/posts\/11889\/revisions\/12016"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/analystik.ca\/blogue\/wp-json\/wp\/v2\/media\/11902"}],"wp:attachment":[{"href":"https:\/\/analystik.ca\/blogue\/wp-json\/wp\/v2\/media?parent=11889"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/analystik.ca\/blogue\/wp-json\/wp\/v2\/categories?post=11889"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/analystik.ca\/blogue\/wp-json\/wp\/v2\/tags?post=11889"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}