{"id":12165,"date":"2020-12-03T13:42:42","date_gmt":"2020-12-03T19:42:42","guid":{"rendered":"https:\/\/gsb.lat\/agile-documentation-the-useful-and-necessary\/"},"modified":"2023-04-04T09:54:39","modified_gmt":"2023-04-04T15:54:39","slug":"agile-documentation-the-useful-and-necessary","status":"publish","type":"post","link":"https:\/\/gsb.lat\/en\/agile-documentation-the-useful-and-necessary\/","title":{"rendered":"Agile Documentation: The useful and necessary"},"content":{"rendered":"\n<ul class=\"wp-block-list\"><li>We document to help <strong><em>others and ourselves<\/em>: <\/strong>To teach, to those unfamiliar with a system, how it is structured, installed and operates.  <\/li><li>For <strong>\n  <em>use, operate, support and maintain<\/em>\n<\/strong> the software over time.  <\/li><li>To <strong>\n  <em>reflect on the product, <\/em>\n<\/strong>help to solidify and discover aspects that were not contemplated.<\/li><li>For <strong>\n  <em>support communication with external groups and audits, as a complement to face-to-face discussions, e-mails or<\/em>\n<\/strong>as a complement to face-to-face discussions, e-mails or collaborative tools.  <\/li><li><strong>\n  <em>It links design and coding <\/em>\n<\/strong>to convey the message or to help us not to forget something.  <\/li><li><strong>\n  <em>Reduces the cost<\/em>\n<\/strong> of maintaining legacy code that is difficult to understand and evolve.<\/li><li>Must <strong>be up to date<\/strong>, <strong>\n  <em>easy to locate<\/em>\n<\/strong>, <strong>\n  <em>to read and interpret<\/em>\n<\/strong>.<\/li><li>Documentation in Agile is a living thing <strong>\n  <em>alive, kept light and simple.<\/em>\n<\/strong><\/li><li>It is written <strong>\n  <em>just in time<\/em>\n<\/strong>When it is needed, when it is needed, before it increases the risk of out-of-date and rework.<\/li><li><strong>\n  <em>Documentation is included in the agile process, <\/em>\n<\/strong>it is part of the effort and cost of the product.<\/li><li>It is part of the <strong>\n  <em>continuous delivery<\/em>\n<\/strong> of the software running.  <\/li><li>Documenting is a <strong>\n  <em>process<\/em>\n<\/strong> <strong>\n  <em>collaborative process<\/em>\n<\/strong> where every member of the team contributes.  <\/li><li>Have a <strong>\n  <em>person to manage the documentation process; someone who understands the aspects to be covered and who<\/em>\n<\/strong>someone who understands the issues to be addressed and who handles version control. <strong>\n  <em>version control<\/em>\n<\/strong>.  <\/li><li>Document what helps the <strong>\n  <em>help the team to do its work, and that which<\/em>\n<\/strong> and that which <strong>\n  <em>accompanying the product <\/em>\n<\/strong>for its use and maintenance. Some examples:<\/li><li><strong>\n  <em>Teamwork Team<\/em>\n<\/strong>Team members, communication data, preferences and particularities<\/li><li><strong>\n  <em>Team Agreements<\/em>\n<\/strong>Definition of Ready (DoR), Definition of Done (DoD), Documentation Standards, among others.<\/li><li><strong>\n  <em>Retrospectives<\/em>\n<\/strong>Results of the dynamics and Improvement Actions, follow-up and analysis of results.<\/li><li><strong>\n  <em>Startup Doc.<\/em>\n<\/strong>Product or project sheet, Prototypes, User Story Mapping, High level requirements, &#8230;<\/li><li><strong>\n  <em>Product Functional Doc.<\/em>\n<\/strong>: Process Map, System Navigation, User Guides, &#8230;<\/li><li><strong>\n  <em>Technical Product Documentation<\/em>\n<\/strong>System architecture, data maps, services (APIs), deployment guides, software installation and operation guides.<\/li><\/ul>\n\n<p>Read more in: <a rel=\"noreferrer noopener\" href=\"https:\/\/masteringbusinessanalysis.com\/mba086-docops-keep-your-documentation-agile\/\" target=\"_blank\">DocOps &#8211; Keep Your Documentation Agile<\/a><\/p>\n\n<p class=\"has-text-align-right\">Mar\u00eda Esther Remedios<\/p>\n\n<p class=\"has-text-align-right\">@soy.agile.coach<\/p>\n","protected":false},"excerpt":{"rendered":"<p>We document to help others and ourselves: To teach, to those unfamiliar with a system, how it is structured, installed and operates. For use, operate, support and maintain the software over time. To reflect on the product, help to solidify and discover aspects that were not contemplated. For support communication with external groups and audits,&hellip;<\/p>\n","protected":false},"author":3,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[455],"tags":[557],"class_list":["post-12165","post","type-post","status-publish","format-standard","hentry","category-blog-english","tag-mexico-en","category-455","description-off"],"_links":{"self":[{"href":"https:\/\/gsb.lat\/en\/wp-json\/wp\/v2\/posts\/12165","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/gsb.lat\/en\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/gsb.lat\/en\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/gsb.lat\/en\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/gsb.lat\/en\/wp-json\/wp\/v2\/comments?post=12165"}],"version-history":[{"count":1,"href":"https:\/\/gsb.lat\/en\/wp-json\/wp\/v2\/posts\/12165\/revisions"}],"predecessor-version":[{"id":12169,"href":"https:\/\/gsb.lat\/en\/wp-json\/wp\/v2\/posts\/12165\/revisions\/12169"}],"wp:attachment":[{"href":"https:\/\/gsb.lat\/en\/wp-json\/wp\/v2\/media?parent=12165"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/gsb.lat\/en\/wp-json\/wp\/v2\/categories?post=12165"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/gsb.lat\/en\/wp-json\/wp\/v2\/tags?post=12165"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}