search

ushahidi / platform

Ushahidi Platform API version 3+
http://ushahidi.com
Other
676 stars 506 forks source link

Update COMRADES documentation for EU: due soon! #2004

Closed Shadrock closed 7 years ago

Shadrock commented 7 years ago

Need

The EU Review has requested that we re-submit our last report (here on the Ushahidi G-Drive) with:

"some UML use case and activity/sequence diagrams for the different users of the COMRADES platform."

At present the only diagram in the report is the brief one that @willdoran made to diagram accessing YODIE via web hooks. I don't expect this to be too complicated but I'm not sure... @jshorland can you please advise: do we need a call or does this make sense as is?

Due Date

September 5th, 2017

Shadrock commented 7 years ago

COMRADES deliverable corrections.

willdoran commented 7 years ago

@Shadrock @jshorland I will take a look and see if I can find existing uml/diagrams. @rjmackay do you know of some already?

willdoran commented 7 years ago

rjmackay [17:21] I don't think we have proper UML version

[17:21] Do they want specific ones for COMRADES and the integrations?

[17:21] Sequence diagrams might be specific, but use case diagrams are probably pretty generic.

robbie [17:22] I used a mix of https://www.planttext.com/ and http://nomnoml.com/ to make my other diagrams... although they're both kinda fiddly

will [17:24] I’m not totally sure, I had interpreted it as - UML diagrams showing the user flow + the affect of the comrades integrations

@shadrock is that correct? Secondly, are there distinct user groups(election monitors, human rights defenders, etc) that will need to be diagramed? Or is it more ‘How does a user interact with the Platform + the COMRADES integrations?’

So