Ref Arch Documentation Review: Quoting/Agreements BC

mwmentor commented 2 years ago

Errors and Omissions

The following errors and omissions have been noted and need attention:

Copy

[ ] Descriptions need a bit of work to make them more readable, i.e.: think narrative

Images

[x] Rescale the Functional Overview image
[x] General - UC Flow Diagram title case inconsistent (Upper/Lower mixed)
[x] UC- Calculate Quote - Invalid Quote Request - copy typeface size varies
[x] UC- Calculate Quote - Invalid Scheme Rules detected in response - copy typeface size varies
[x] Add Alt. Text to images
[ ] Where images include embedded URLs, create a list below the image to include the links

Acceptance Criteria:

[ ] TBD

Complexity: <High|Medium|Low> > A short comment to remind the reason for the rating

Uncertainty: <High|Medium|Low> > A short comment to remind the reason for the rating

Tasks:

[ ] TBD [ @? ]

Done

[ ] Acceptance Criteria pass
[ ] Designs are up-to date
[ ] Unit Tests pass
[ ] Integration Tests pass
[ ] Code Style & Coverage meets standards
[ ] Changes made to config (default.json) are broadcast to team and follow-up tasks added to update helm charts and other deployment config.
[ ] TBD

Pull Requests:

[ ] TBD

Follow-up:

N/A

Dependencies:

N/A

Accountability:

Owner: TBC
QA/Review: TBC

mwmentor commented 2 years ago

@elnyry-sam-k Hi Sam... can you help with putting a more narrative-based description in place where required in this BC. Thanks.

mwmentor commented 2 years ago

I have noted an error with the URLs included with all of the UC Workflow Diagrams - POST & GET/quote/s link URLs all 404. I have done some sniffing and have found that the URL has been updated: it was https://docs.mojaloop.io/mojaloop-specification/fspiop-api/documents/API%20Definition%20v1.1.html#6532-post-quotes but should probably now be: https://docs.mojaloop.io/api/fspiop/v1.1/api-definition.html. I have asked @pedrosousabarreto and @mdebarros and @elnyry-sam-k (BC Owners) for assistance.

pedrosousabarreto commented 2 years ago

If the URLS lead to 404's and the BC owners are not available to help, I suggest we remove them.

elnyry-sam-k commented 2 years ago

The URLs have been updated, yes (when the docs were moved to new structure in docs.mojaloop.io). Let me check where we need to make the changes..

mwmentor commented 2 years ago

HI Sam:

Thanks so much. That sounds just fine. If you could send me a list of the changes, I will add them to the images and create click-through reference lists where applicable. BTW: are they likely to change again any time soon? I guess that might be a, "How long is that piece of string question?" 😂 Whatever, I will add comments to the code on what to do should it change in they change again in the future.

Enjoy your day.

Thanks. -Michael

On Tue, 7 Jun 2022 at 15:02, Sam @.***> wrote:

The URLs have been updated, yes (when the docs were moved to new structure in docs.mojaloop.io). Let me check where we need to make the changes..

— Reply to this email directly, view it on GitHub https://github.com/mojaloop/project/issues/2678#issuecomment-1148643189, or unsubscribe https://github.com/notifications/unsubscribe-auth/APY7TF7JV6QTL6FLXQHUU33VN5B6XANCNFSM5N5JFBIA . You are receiving this because you were assigned.Message ID: @.***>

-- Michael Wagener Certified Scrum Master (Accredited); CAL-T; Diploma Project Management: PMBoK (PMI); Member Interaction Design Foundation Webwick Design Studio (Pty) Ltd Tel: +27.878202001 Mob: +27.826187601 Email: @.*** LinkedIn: linkedin/mwagener https://www.linkedin.com/in/mwagener

'If you can't explain it simply, you don't understand it well enough' Albert Einstein

The content of this e-mail and any attachments relating to the official business of Webwick Design Studio (Pty) Ltd (Webwick) is proprietary to Webwick, and is confidential, legally privileged and protected by law. Webwick does not own and endorse any other content. Views and opinions are those of the sender unless clearly stated as being that of Webwick. The person addressed in the e-mail is the sole authorized recipient. Please notify the sender immediately if it has unintentionally reached you and do not read, disclose, or use the content in any way. Webwick cannot assure that the integrity of this communication has been maintained or that it is free of errors, viruses, interception or interference.

mojaloop / project