{"id":739,"date":"2020-05-04T03:27:05","date_gmt":"2020-05-04T03:27:05","guid":{"rendered":"https:\/\/projects-old.etc.cmu.edu\/liftoff\/?p=739"},"modified":"2020-05-04T03:27:05","modified_gmt":"2020-05-04T03:27:05","slug":"week-15-documentation-week","status":"publish","type":"post","link":"https:\/\/projects-old.etc.cmu.edu\/liftoff\/index.php\/2020\/05\/04\/week-15-documentation-week\/","title":{"rendered":"Week 15 – Documentation Week"},"content":{"rendered":"\n

This week, we worked on preparing the documentation for our final handoff.<\/p>\n\n\n\n

Because we have another team after us that will continue working on this project, it\u2019s important for us to produce very detailed documentation so that the next team can easily pick up the tech, design, and how to get the app running.<\/p>\n\n\n\n

Design Documentation<\/h1>\n\n\n\n

For our design documentation, we included all of our design ideas, assets, interfaces, UI elements, source files, and some alternative ideas to give the next team more options.<\/p>\n\n\n\n

\"\"\/<\/figure>\n\n\n\n
\"\"\/<\/figure>\n\n\n\n
\"\"\/<\/figure>\n\n\n\n

Tech Documentation<\/h1>\n\n\n\n

For tech documentation, we included the API list and status code for backend, data, and algorithm for our recommendation system, a manual for our tools, a troubleshooting guide, and a guide for firebase setting up.<\/p>\n\n\n\n

\"\"\/<\/figure>\n\n\n\n
\"\"\/<\/figure>\n\n\n\n
\"\"\/<\/figure>\n\n\n\n
\"\"\/<\/figure>\n\n\n\n
\"\"\/<\/figure>\n\n\n\n
\"\"\/<\/figure>\n\n\n\n

Documentation Playtest<\/h1>\n\n\n\n

To make sure the documentation is easy for people to understand, we got two programmers from other ETC team to playtest our documentation, and here are their feedbacks:<\/p>\n\n\n\n

Charley Li<\/p>\n\n\n\n

  • Typo in README file
    • \u201cFrom nothing\u201d<\/li><\/ul><\/li>
    • Not sure if \u201clocalhost run\u201d can be viewed on the phone
      • Will it be blocked by the firewall?<\/li><\/ul><\/li><\/ul>\n\n\n\n

        Jiming Li<\/p>\n\n\n\n

        • Generally very easy to understand<\/li>
        • Very detailed and formal<\/li>
        • If we include more screenshots it can be better (tool manual, etc)<\/li>
        • Can include a flow chart, stating how the app work, from start to the end (design)<\/li><\/ul>\n\n\n\n

          So generally they think it\u2019s very detailed and easy to understand, but more screenshots and a flow chart would be better, so added them into our documentation<\/p>\n\n\n\n

          <\/p>\n\n\n\n

          \"\"<\/figure>\n\n\n\n

          .<\/p>\n\n\n\n

          Next week is the last week of our project, and we will have a final presentation via Zoom to show the faculties our process and answer their questions. We are very excited!<\/p>\n","protected":false},"excerpt":{"rendered":"

          This week, we worked on preparing the documentation for our final handoff. Because we have another team after us that will continue working on this project, it\u2019s important for us to produce very detailed documentation so that the next team can easily pick up the tech, design, and how to get the app running. Design […]<\/p>\n","protected":false},"author":2,"featured_media":741,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-739","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-uncategorized"],"_links":{"self":[{"href":"https:\/\/projects-old.etc.cmu.edu\/liftoff\/index.php\/wp-json\/wp\/v2\/posts\/739"}],"collection":[{"href":"https:\/\/projects-old.etc.cmu.edu\/liftoff\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/projects-old.etc.cmu.edu\/liftoff\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/projects-old.etc.cmu.edu\/liftoff\/index.php\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/projects-old.etc.cmu.edu\/liftoff\/index.php\/wp-json\/wp\/v2\/comments?post=739"}],"version-history":[{"count":1,"href":"https:\/\/projects-old.etc.cmu.edu\/liftoff\/index.php\/wp-json\/wp\/v2\/posts\/739\/revisions"}],"predecessor-version":[{"id":742,"href":"https:\/\/projects-old.etc.cmu.edu\/liftoff\/index.php\/wp-json\/wp\/v2\/posts\/739\/revisions\/742"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/projects-old.etc.cmu.edu\/liftoff\/index.php\/wp-json\/wp\/v2\/media\/741"}],"wp:attachment":[{"href":"https:\/\/projects-old.etc.cmu.edu\/liftoff\/index.php\/wp-json\/wp\/v2\/media?parent=739"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/projects-old.etc.cmu.edu\/liftoff\/index.php\/wp-json\/wp\/v2\/categories?post=739"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/projects-old.etc.cmu.edu\/liftoff\/index.php\/wp-json\/wp\/v2\/tags?post=739"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}