Documentation to-do list

[AnnaDearman]

Hi all,

I've noticed some sections missing from the documentation on Google Docs and I thought I'd list them here so we can discuss whether anyone's already working on them (I'm sure several are already being worked on):

• [x] SQLAlchemy queries
• [x] Flask
• [x] (Don't we need some sort of user guide, with an example of how to use it, and possibly screen shots?)
• [x] Testing - am I writing this?? There are notes about testing different browsers, but what about other tests, i.e. of functionality?
• [x] Prospective work
• [x] References (I've made a start but we've got lots of packages to reference properly)
• [x] Put figure numbers in at the end

I realise I haven't written anything about AWS yet either

P.S. in the README it's JACKY version 1, and in the documentation it's JACKY: an un-versioned prototype. Majority vote on what to go with? 😁

[JuanLM1978]

I would say that queries and Flask in the end were together. We can merge then in the same section Flask. If so I guess we should do the same in the presentation.

The user guide was an idea that my colleague suggested and i thought it was good but I dont know if we still have time to do it...

Prospective work? I will try to think about something else to do and will let you know tomorrow in the morning. However if we do prospective work we should start with a first version for sure different than the second one which would include the prospective work. Does it makes sense?

[AnnaDearman]

We have to outline the design philosophy - is this covered in what we've already done? What exactly does this mean?

[JuanLM1978]

I guess it is the reason why you chose to use a specific method/library/tool rather than others... justifications to the decisions that we made?

[JuanLM1978]

If it is something like that there is something covered on the documenation i kind of remember