UI planning: wireframes and feature lists
Hand in your work via your team's chosen GitHub repository. Document names and locations as specified below.
Now that you have your development tools and general project architectures well underway, I would like you to put time into writing down your thoughts about your tool's user interface and how that interface will help your users achieve their goals.
What to push to GitHub
A file
doc/ui.txtordoc/ui.md. This file should describe briefly the user-facing features you hope to be able to implement by the end of week 8 of the term (say, the end of the day Monday, May 26). You may describe these features in ordinary unstructured prose. Alternatively, you may find it helpful to adopt the language of user stories (roughly "person A with role B performs concrete action C to achieve goal D").A directory
doc/wireframescontaining images of your user interface as multiple jpg or png files or a single pdf file. (The term wireframe is widely used, and there are a lot of good blogs about wireframes.)Sketch your interfaces in a way that I will have a very clear idea what you're trying to build, that maps in obvious ways to the features you described in
ui.txt. I'm happy to receive wireframe images created with drawing software, carefully drawn by hand and photographed in good light, etc.If you already have user interfaces implemented that are close to your goal in appearance, you may use screenshots for relevant screens in lieu of wireframe drawings.
If your application is a command-line application, you may skip the wireframes in favor of
doc/man.txtordoc/man.md, which contains a man-page-style description of your tool's (or tools') command-line syntax.