{"action":"created","issue":{"url":"https://api.github.com/repos/uidaho/squireproject/issues/142","repository_url":"https://api.github.com/repos/uidaho/squireproject","labels_url":"https://api.github.com/repos/uidaho/squireproject/issues/142/labels{/name}","comments_url":"https://api.github.com/repos/uidaho/squireproject/issues/142/comments","events_url":"https://api.github.com/repos/uidaho/squireproject/issues/142/events","html_url":"https://github.com/uidaho/squireproject/issues/142","id":151954681,"number":142,"title":"Put together end-of-semester documentation","user":{"login":"backburn","id":784730,"avatar_url":"https://avatars.githubusercontent.com/u/784730?v=3","gravatar_id":"","url":"https://api.github.com/users/backburn","html_url":"https://github.com/backburn","followers_url":"https://api.github.com/users/backburn/followers","following_url":"https://api.github.com/users/backburn/following{/other_user}","gists_url":"https://api.github.com/users/backburn/gists{/gist_id}","starred_url":"https://api.github.com/users/backburn/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/backburn/subscriptions","organizations_url":"https://api.github.com/users/backburn/orgs","repos_url":"https://api.github.com/users/backburn/repos","events_url":"https://api.github.com/users/backburn/events{/privacy}","received_events_url":"https://api.github.com/users/backburn/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/uidaho/squireproject/labels/documentation","name":"documentation","color":"e99695"},{"url":"https://api.github.com/repos/uidaho/squireproject/labels/sprint%20requirement","name":"sprint requirement","color":"b60205"}],"state":"open","locked":false,"assignee":null,"milestone":{"url":"https://api.github.com/repos/uidaho/squireproject/milestones/3","html_url":"https://github.com/uidaho/squireproject/milestones/HW8%20Metrics","labels_url":"https://api.github.com/repos/uidaho/squireproject/milestones/3/labels","id":1739218,"number":3,"title":"HW8 Metrics","description":"Due: in-class May 4 for code/demo. 5 pm May 13 for documentation.\r\n\r\nBroad Goals\r\n- Put together a runnable finished product\r\n- Put together end-of-semester documentation\r\n- Whatever backlog items your team deems essential for finished product\r\n- Expand testing section to include elements of integration and/or system testing\r\n- Identify a modest list of easy-to-obtain metrics for your system. Include at least: #directories, #files, #classes, #methods, largest class/method, source lines of code, static disk requirements for binary distribution, run-time memory requirements.\r\n- Means of Distribution: how can someone download and run your project? If client/server, this is three different things: how to download and run a client, how to download and run a server, and any configuration or pairing actions needed to point the clients at the server.\r\n- Usability: enough documents or in-game instructions so someone can figure out how to run your project, including the mechanics of various use cases.","creator":{"login":"backburn","id":784730,"avatar_url":"https://avatars.githubusercontent.com/u/784730?v=3","gravatar_id":"","url":"https://api.github.com/users/backburn","html_url":"https://github.com/backburn","followers_url":"https://api.github.com/users/backburn/followers","following_url":"https://api.github.com/users/backburn/following{/other_user}","gists_url":"https://api.github.com/users/backburn/gists{/gist_id}","starred_url":"https://api.github.com/users/backburn/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/backburn/subscriptions","organizations_url":"https://api.github.com/users/backburn/orgs","repos_url":"https://api.github.com/users/backburn/repos","events_url":"https://api.github.com/users/backburn/events{/privacy}","received_events_url":"https://api.github.com/users/backburn/received_events","type":"User","site_admin":false},"open_issues":6,"closed_issues":0,"state":"open","created_at":"2016-04-29T19:40:54Z","updated_at":"2016-04-29T20:02:26Z","due_on":"2016-05-04T07:00:00Z","closed_at":null},"comments":1,"created_at":"2016-04-29T19:51:48Z","updated_at":"2016-05-04T05:48:25Z","closed_at":null,"body":"http://www2.cs.uidaho.edu/~jeffery/courses/383/lecture.html#lecture31\r\n\r\n**Coordinating the End of Semester Project Document**\r\n\r\nRecommended: everyone allocate a couple/few hours for end-of-semester documentation. Concatenate it all together to form one big document.\r\n\r\nRequirements\r\n    Review/update SSRS / Use Cases and Descriptions\r\n\r\nDesign\r\n    Review/update SSDD / Class Diagrams, Statecharts, architecture, protocol...\r\n\r\nImplementation\r\n    Code organization overview. Description of major components/folders (client, server, ..., but maybe a level or two more detailed). Description of how it is built. Which IDE(s)? Number of targets in IDE. What does it look like to run outside an IDE? What does a client binary distribution look like, and how portable is it? What about a server (or client/server) binary distribution, and how portable is it?\r\n\r\nTesting\r\n- Test Plans, tests actually run, test results, test coverage.\r\n- Possibly: fill in the blanks, and remove the \"Template\"-ness of existing Test Plans. Alternatively: write from scratch, address major test areas.\r\n- Concatenate or Merge subteam Test Plans to form combined Test Plan.\r\n- Write textual descriptions of Test Cases for everything that's not junit-integrated.\r\nMinimally, your goal is to convince me that you did reasonable (unit or manual) testing for any code you claim that you implemented.\r\n\r\nMetrics\r\n- Source code metrics.\r\n- Executable/binary code metrics.\r\n- Execution (run-time) metrics.\r\n- Repository metrics.\r\n- Team metrics.\r\nWhatever is relatively easy to measure, if it appears potentially useful. You can include with metrics your evaluation of whether it appears to be credible/accurate.\r\n\r\n**Q & A**\r\n\r\nShould the final document be a PDF document?\r\n    Sure\r\nMust we really do it in LaTeX?\r\n    LaTeX was specified for the document in order to facilitate multi-person collaboration via Git. ASCII-based document formats are in general better for merging multiple persons' work into revision control repositories. I have previously successfully converted entire books from Word to LaTeX using appropriate tools such as OpenOffice. However, I am a pragmatist: I will take what I can get. Decide with your team how to best coordinate.\r\nMust we really follow those tedious IEEE templates?\r\n    The IEEE templates feel pretty dated to me. Treat them as guidelines, not hard rules. If you don't use the templates as-is, I recommend that you cover a similar scope for the different chapters, and approach a similar level of detail, except emphasizing what your team actually did and what you learned from the experience.\r\nFeel free to ask additional questions."},"comment":{"url":"https://api.github.com/repos/uidaho/squireproject/issues/comments/216750734","html_url":"https://github.com/uidaho/squireproject/issues/142#issuecomment-216750734","issue_url":"https://api.github.com/repos/uidaho/squireproject/issues/142","id":216750734,"user":{"login":"backburn","id":784730,"avatar_url":"https://avatars.githubusercontent.com/u/784730?v=3","gravatar_id":"","url":"https://api.github.com/users/backburn","html_url":"https://github.com/backburn","followers_url":"https://api.github.com/users/backburn/followers","following_url":"https://api.github.com/users/backburn/following{/other_user}","gists_url":"https://api.github.com/users/backburn/gists{/gist_id}","starred_url":"https://api.github.com/users/backburn/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/backburn/subscriptions","organizations_url":"https://api.github.com/users/backburn/orgs","repos_url":"https://api.github.com/users/backburn/repos","events_url":"https://api.github.com/users/backburn/events{/privacy}","received_events_url":"https://api.github.com/users/backburn/received_events","type":"User","site_admin":false},"created_at":"2016-05-04T05:48:25Z","updated_at":"2016-05-04T05:48:25Z","body":"@brec9824 @rickbau5 compiled project phpdocs can be found at https://squireproject.com/docs/index.html"}}