search

plberg / cs373-idb

Project 3 (IDB) for CS 373: Software Engineering
0 stars 1 forks source link

Write an initial technical report. #8

Closed jabrouwer82 closed 9 years ago

jabrouwer82 commented 9 years ago

The audience comprises other software developers, as opposed to users. For this phase make it at least 10 pages. Document the RESTful API and the Flask models well. Format the report clearly, attractively, and consistently, using good headers, figures, and grammar.

Section Features
Title The group name. The group members.
Introduction What is the problem? What are the use cases?
Design RESTful API, Flask models
Tests unit tests of the Flask models
Other Proof-read your report. Get another group to read it. Read it aloud. Create diagrams with captions. Create sections and subsections effectively.
jabrouwer82 commented 9 years ago

Created, editable at https://docs.google.com/document/d/1L0VnJmeWCnRzO4qqjWatKB3bYTyAww0I9BKXxLZq2iA/edit?usp=sharing

jabrouwer82 commented 9 years ago

It looks like we have 10 pages total, but that includes a title page and I'd prefer we had more than enough. I've added a bunch of stuff about our configurations and source code. I also consolidated the information in the doc. Once the apiary stuff is in and discussed, we should be well over 10 pages double spaced.