search

EventideSystems / tool_for_systemic_change

GNU Affero General Public License v3.0
3 stars 0 forks source link

Review User Help Guides and update or create new SDG Help guides #724

Open emily-humphreys opened 2 years ago

emily-humphreys commented 2 years ago

Describe the task

Review User Help Guides and update or create new SDG Help guides wiz password: 12Qwaszx!@

Success Criteria

How will we know if we've completed the task successfully? Use MUST, MUST NOT, SHOULD, MAY qualifiers for each criteria.

Additional Notes

The first step would be to review the Transition Card content:

Current list of user guides at https://www.wickedlab.co/help

SishaMish commented 2 years ago

@emily-humphreys An update on the User Guides.

I've been working through each of the guides, and have created a duplicate of each page. All new edits have been made on these duplicates.

  1. Edits that I have made have mostly been to fix typos, making sure all elements are being referred to in a consistent manner (capitalising things like 'Initiatives', 'Communities' and 'Organisations'), making sure references in the user guides are the exact same wording that appears on the relevant screen, changing a call to action (ie, Click 'OK') from being in quotation marks to being in a bold font.

  2. I have been playing with the layout, trying to tweak the page to look better on mobile view that was displaying with large gaps between text and images. I believe I've fixed the issue by creating each block of text as a seperate element on the webpage and inserting the images in between these blocks. The tweaked example is 'Copy 2 of 1. Transition Cards' if you want to take a look. Let me know if you want me to make these changes to all of the user guides.

  3. I have also thought that making the screenshots the same width as the text block to be better. I was personally finding it hard to read some of the elements on the screenshot, and believe that others may struggle with this too. I have only done this change in the Copy 2 as mentioned above, while playing with the layout. Let me know if you're happy to use this in all the pages.

  4. I have not yet updated any screenshots. I want to make sure that the screenshots I use have the information on them that you would prefer, ie username etc.

Let me know your thoughts so far.

emily-humphreys commented 2 years ago

All these look fantastic.

You've done a terrific job - thank you!

Agreed the screenshots look much better at the dimensions you've set up - and yes I think we need to update these. Thank you

I think editing your name to 'User' will make this look applicable to all consumers of the guides.

I will also start getting the SDG Alignment Card example set up in the demo account

We'd

On Tue, Apr 12, 2022 at 2:23 PM SishaMish @.***> wrote:

@emily-humphreys https://github.com/emily-humphreys An update on the User Guides.

I've been working through each of the guides, and have created a duplicate of each page. All new edits have been made on these duplicates.

1.

Edits that I have made have mostly been to fix typos, making sure all elements are being referred to in a consistent manner (capitalising things like 'Initiatives', 'Communities' and 'Organisations'), making sure references in the user guides are the exact same wording that appears on the relevant screen, changing a call to action (ie, Click 'OK') from being in quotation marks to being in a bold font. 2.

I have been playing with the layout, trying to tweak the page to look better on mobile view that was displaying with large gaps between text and images. I believe I've fixed the issue by creating each block of text as a seperate element on the webpage and inserting the images in between these blocks. The tweaked example is 'Copy 2 of 1. Transition Cards' if you want to take a look. Let me know if you want me to make these changes to all of the user guides. 3.

I have also thought that making the screenshots the same width as the text block to be better. I was personally finding it hard to read some of the elements on the screenshot, and believe that others may struggle with this too. I have only done this change in the Copy 2 as mentioned above, while playing with the layout. Let me know if you're happy to use this in all the pages. 4.

I have not yet updated any screenshots. I want to make sure that the screenshots I use have the information on them that you would prefer, ie username etc.

Let me know your thoughts so far.

— Reply to this email directly, view it on GitHub https://github.com/ferrisoxide/wicked_software/issues/724#issuecomment-1096029303, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADFVZORRNRXQLQZ57JGKLQLVET6VZANCNFSM5SHP63XQ . You are receiving this because you were mentioned.Message ID: @.***>

SishaMish commented 2 years ago

@emily-humphreys I think I've completed all the User Guides for the Transition Cards. Tasks completed are:

emily-humphreys commented 2 years ago

* Thank you this is wonderful! Do you have this list of:

  1. screenshots that were hard to recreate?
  2. What links are not working?

Ps I have now created the SDG Alignment Card on the same account and completed the mapping

SishaMish commented 2 years ago

The last two screenshots to do are the import error pages on user guide page 7 and on page 10.

The broken links are all the links to other pages in the user guide. I've looked up how to add hyperlinks to text, but I don't know the URL of the pages I'm linking to or how to find that out. These links appear on pages 1, 3, 4, 7, 10 and 13 as underlined text.

The other things are the links to downloadable content ie. templates etc. As I have moved text and buttons around, I'm unsure if these links are still working. Will have to investigate!

I haven't looked at the SDG Alignment Card page yet - will get on to that soon.

emily-humphreys commented 2 years ago

Hi Lisa,

I've gone through the User Guide List and categorised it with comments in the attached spreadsheet.

There are 3 main actions:

  1. Small update to include 'or SDGs Alignment Card' when Transition Cards are referenced
  2. Copy a User Guide and update it with SDGs Alignment Card terminology/screenshots
  3. Create new SDGs specific User Guides

Let me know if you need any clarification on this Thanks! User Guide update April 22 SDGs.xlsx

SishaMish commented 2 years ago

@emily-humphreys

Hi Emily. I've just realised while replicating the 'Mapping Initiatives' page to adapt it to an SDGs version, that there is probably some key points missing from the original page. In Section 1. on that page, there is no mention of tagging comments as 'Actual' 'Planned' etc. It only mentions that once the comment is completed and saved the text will turn blue. I am assuming that users are not just going to be marking all comments as 'Actual' every time, and that this is a place that requires some explanation of the different statuses that comments can have, and therefore the different coloured text that can appear after saving. Is that correct?

i just want to clarify that with you before i start making a major change here.

SishaMish commented 2 years ago

@emily-humphreys A note about the videos. I watched through them all on Friday and took some notes. The videos that are still mostly up to date are:

The videos that are mostly out of date are:

Lastly, Creating Initiatives is displaying the wrong video, and is linked to the Creating Organisations video.

emily-humphreys commented 2 years ago

@Lisa Tuddenham @.***> I have finally been able to take the time to look at your excellent work. You have done an outstanding job.

Thanks for looking at the video - I've added the videos to my 'update pile'. I've also added the correct initiative video to the page.

Next steps. Would you be happy to do another 10 hours @40 + gst to complete the following?

If you get to 10 hours and need more time - just let me know!

On Mon, May 2, 2022 at 12:04 PM SishaMish @.***> wrote:

@emily-humphreys https://github.com/emily-humphreys A note about the videos. I watched through them all on Friday and took some notes. The videos that are still mostly up to date are:

  • Creating Communities
  • Creating Organisations
  • Wicked Problems
  • Subsystem Tags
  • Print and Download Transition Card (though the icons for 'Print' 'Share' etc. look different than what is currently in use)

The videos that are mostly out of date are:

  • Transition Card (the Initiatives section is old, missing current functionality)
  • Mapping Initiatives (doesn't show the current info on adding a status to the comment)
  • Share (the pop up screen doesn't show any of the iFrame information)

Lastly, Creating Initiatives is displaying the wrong video, and is linked to the Creating Organisations video.

— Reply to this email directly, view it on GitHub https://github.com/ferrisoxide/wicked_software/issues/724#issuecomment-1114441755, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADFVZOSVBR5L4DJ3BS3Y3XTVH45LZANCNFSM5SHP63XQ . You are receiving this because you were mentioned.Message ID: @.***>

SishaMish commented 2 years ago

@emily-humphreys If you get a chance to take a look, I've filled out the Linking and Unlinking Initiatives user guide and broken it up into smaller sections. Let me know if this is on the right track.

I'll move on to the other parts either tomorrow, or next week. I'm working at a polling booth on Saturday, and I know I'll need a day or so to recover - last time I did it, I was a complete wreck the next day!

emily-humphreys commented 2 years ago

How are you feeling post-election day! I feel hopeful for the first time is many year

Not a problem re -recovery.

Ps these new updates to Linked initiatives are excellent! Can we add some screenshots for the three scenarios under 'Linking and Unlinking Initiatives'?

Ps can I also add something to the list above (an annoying screenshot update related to #756) Can we update the screenshots for the targets when the shorten description of the targets are updated?

On Thu, May 19, 2022 at 5:56 PM SishaMish @.***> wrote:

@emily-humphreys https://github.com/emily-humphreys If you get a chance to take a look, I've filled out the Linking and Unlinking Initiatives user guide and broken it up into smaller sections. Let me know if this is on the right track.

I'll move on to the other parts either tomorrow, or next week. I'm working at a polling booth on Saturday, and I know I'll need a day or so to recover

  • last time I did it, I was a complete wreck the next day!

— Reply to this email directly, view it on GitHub https://github.com/ferrisoxide/wicked_software/issues/724#issuecomment-1131394936, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADFVZOUHFC7AZ7G332Q7DF3VKX3LPANCNFSM5SHP63XQ . You are receiving this because you were mentioned.Message ID: @.***>

SishaMish commented 2 years ago

Such a long day! 7am start until around 11pm. My back doesn't ache so much today :)

I'll take a look at the screenshots shortly. Shouldn't be a hassle.

SishaMish commented 2 years ago

@emily-humphreys Hey! Are there Word documents of the Report Explainers available for me to edit? It would be easier to update the TC Report Explainers with SDGs info than to try and recreate the pages with logos etc.

emily-humphreys commented 2 years ago

They are - I have emailed them through to you

On Thu, May 26, 2022 at 12:21 PM SishaMish @.***> wrote:

@emily-humphreys https://github.com/emily-humphreys Hey! Are there Word documents of the Report Explainers available for me to edit? It would be easier to update the TC Report Explainers with SDGs info than to try and recreate the pages with logos etc.

— Reply to this email directly, view it on GitHub https://github.com/ferrisoxide/wicked_software/issues/724#issuecomment-1138089827, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADFVZOR4PFMSCAUTWMM7H33VL3RLLANCNFSM5SHP63XQ . You are receiving this because you were mentioned.Message ID: @.***>

SishaMish commented 2 years ago

@emily-humphreys Thank you. Got em. I should have perhaps asked this earlier, but I just want to get some clarity on the language I'm using to describe the SDGs cards. When I'm looking at a SDGs card, the 17 different groups are called 'Target Goals' or just 'Targets'? And when I am looking at the details of a SDGs Card, what are the subcategories of the goals (ie, 1.1, 1.2, etc) Are these still called Initiative Characteristics?

Writing up the Report Explainers I've realised I might be naming things incorrectly.

SishaMish commented 2 years ago

@emily-humphreys Just to let you know where I am at.

Finished tasks:

  1. Screenshots for Linking and Unlinking Initiatives
  2. Mapping Initiatives - Updating Comments and Saved New Comments added to both TC and SDG User guides
  3. I've linked all the pages to the front pages of the user guides (both SDG and TC). I've also gone through the user guide pages and linked any hyperlinks to their relevant pages
  4. SDG Target Network Map (from previous email) - This has all been checked. All the links are connected on the map as indicated by the tables in the document BUT one of the nodes is missing from the Table in the PDF - SDG 13: Climate Change is missing 13.3 - the node is on the network map, and is connected to SDG 4. The only place it is missing is on the PDF under SDG 13.

Still to do:

  1. Report Explainers (still need clarification from previous email regarding language to use)
  2. Ecosystem Map (have started but am a bit lost regarding what needs to be explained in the user guide - I'll have a crack, but if you have any input let me know)
  3. Updating screenshot re: ticket #756
emily-humphreys commented 2 years ago

Thanks for clarifying :)

The hierarchy is:

Sustainable Development Goals = refers to all 17 goals Sustainable Development Goal = Goal 1 (etc) Targets = Refers to all the targets listed under an individual Goal Target = refers to the specific target such as 1.1

How this translates to Transition Card language is: Sustainable Development Goals = would be the equivalent of Focus Areas Sustainable Development Goal = would be the equivalent of a Focus Area e.g Focus Area 1 Targets = would be the equivalent of all the initiative characteristics under a Focus Area Target = would be equivalent to an initiative characteristic

https://en.wikipedia.org/wiki/Sustainable_Development_Goals

does that make sense?

On Thu, May 26, 2022 at 2:30 PM SishaMish @.***> wrote:

@emily-humphreys https://github.com/emily-humphreys Thank you. Got em. I should have perhaps asked this earlier, but I just want to get some clarity on the language I'm using to describe the SDGs cards. When I'm looking at a SDGs card, the 17 different groups are called 'Target Goals' or just 'Targets'? And when I am looking at the details of a SDGs Card, what are the subcategories of the goals (ie, 1.1, 1.2, etc) Are these still called Initiative Characteristics?

Writing up the Report Explainers I've realised I might be naming things incorrectly.

— Reply to this email directly, view it on GitHub https://github.com/ferrisoxide/wicked_software/issues/724#issuecomment-1138155244, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADFVZOVPLH7KCYFMQ3VBQ63VL4AP5ANCNFSM5SHP63XQ . You are receiving this because you were mentioned.Message ID: @.***>

emily-humphreys commented 2 years ago

This is fantastic and thank you for the update! You are really a dream to work with :)

  1. Screenshots for Linking and Unlinking Initiatives - terrific are you able to make the spacing between the sentences bigger as some parts of the text look super dense
  2. Mapping Initiatives - Updating Comments and Saved New Comments added to both TC and SDG User guides This is great - as above can we chunk it up so its a less dense
  3. I've linked all the pages to the front pages of the user guides (both SDG and TC). I've also gone through the user guide pages and linked any hyperlinks to their relevant pages - great!!
  4. SDG Target Network Map (from previous email) - This has all been checked. All the links are connected on the map as indicated by the tables in the document BUT one of the nodes is missing from the Table in the PDF - SDG 13: Climate Change is missing 13.3 - the node is on the network map, and is connected to SDG 4. The only place it is missing is on the PDF under SDG 13 - great pick up I will let Sharon know and we will update.

Notes on to do

  1. Report Explainers (still need clarification from previous email regarding language to use) I think this might now be above this response
  2. Ecosystem Map (have started but am a bit lost regarding what needs to be explained in the user guide - I'll have a crack, but if you have any input let me know) - this is coming together. I will send you the feature 1 pager for you to see the 'selling points' and this can help shape what we want people to be able to navigate to via User Guides
  3. Updating screenshot re: ticket #756 https://github.com/ferrisoxide/wicked_software/issues/756 - I still need to check with Tom where this is at

Please invoice me for all the work you have done so far. I'm eager to pay you as you've done so much. The remaining you can invoice #2. What do you think?

On Tue, May 31, 2022 at 3:35 PM SishaMish @.***> wrote:

@emily-humphreys https://github.com/emily-humphreys Just to let you know where I am at.

Finished tasks:

  1. Screenshots for Linking and Unlinking Initiatives
  2. Mapping Initiatives - Updating Comments and Saved New Comments added to both TC and SDG User guides
  3. I've linked all the pages to the front pages of the user guides (both SDG and TC). I've also gone through the user guide pages and linked any hyperlinks to their relevant pages
  4. SDG Target Network Map (from previous email) - This has all been checked. All the links are connected on the map as indicated by the tables in the document BUT one of the nodes is missing from the Table in the PDF - SDG 13: Climate Change is missing 13.3 - the node is on the network map, and is connected to SDG 4. The only place it is missing is on the PDF under SDG 13.

Still to do:

  1. Report Explainers (still need clarification from previous email regarding language to use)
  2. Ecosystem Map (have started but am a bit lost regarding what needs to be explained in the user guide - I'll have a crack, but if you have any input let me know)
  3. Updating screenshot re: ticket #756 https://github.com/ferrisoxide/wicked_software/issues/756

— Reply to this email directly, view it on GitHub https://github.com/ferrisoxide/wicked_software/issues/724#issuecomment-1141701281, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADFVZOVQLVXBJXXPFSOPZALVMWT33ANCNFSM5SHP63XQ . You are receiving this because you were mentioned.Message ID: @.***>

SishaMish commented 2 years ago

@emily-humphreys

Thanks for all info and feedback. I'll get on to it ASAP. I'll also write up the invoice for the first part of the User Guides and send it to you this afternoon.

SishaMish commented 2 years ago

@emily-humphreys

I think it's all finished - I've just added the new screen shots to the Mapping Initiatives SDG page. Did you want anything added to that page to explain the info button and the pop up with the wiki link?

I'm also not sure where to upload the pdfs of the report explainers. I might email them to you to check over anyway.

If you can have a look through that last lot of work and let me know if there are any changes required, that would be great.

SDGs Activity Report Explainer v2.pdf SDGs Comment Report Explainer.pdf SDGs Stakeholder Report Explainer.pdf

emily-humphreys commented 2 years ago

All of this looks excellent.

Just flagging that when we update the reporting to no longer track 'tick and untick' (only saved actual comments) we'll need to revisit these.

If you can upload these PDFs to the SDG reports page where the Transition Card place holders are that would be superb :)

And yes please do send me the word doc versions of the SDG explainers

Thank you!

On Wed, Jun 15, 2022 at 6:06 PM SishaMish @.***> wrote:

@emily-humphreys https://github.com/emily-humphreys

I think it's all finished - I've just added the new screen shots to the Mapping Initiatives SDG page. Did you want anything added to that page to explain the info button and the pop up with the wiki link?

I'm also not sure where to upload the pdfs of the report explainers. I might email them to you to check over anyway.

If you can have a look through that last lot of work and let me know if there are any changes required, that would be great.

SDGs Activity Report Explainer v2.pdf https://github.com/ferrisoxide/wicked_software/files/8907414/SDGs.Activity.Report.Explainer.v2.pdf SDGs Comment Report Explainer.pdf https://github.com/ferrisoxide/wicked_software/files/8907415/SDGs.Comment.Report.Explainer.pdf SDGs Stakeholder Report Explainer.pdf https://github.com/ferrisoxide/wicked_software/files/8907416/SDGs.Stakeholder.Report.Explainer.pdf

— Reply to this email directly, view it on GitHub https://github.com/ferrisoxide/wicked_software/issues/724#issuecomment-1156168902, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADFVZOUCCQWDC4TK555O533VPGIZJANCNFSM5SHP63XQ . You are receiving this because you were mentioned.Message ID: @.***>

SishaMish commented 2 years ago

@emily-humphreys

The SDGs Report Explainers are all attached. Also noticed some wording that needed updating on that page that I had missed. I put the PDFs in to the SDGs screenshot folder.

I'll also email the word docs to you. I had some trouble reading them in Word on my end - something odd happened with the formatting of the text. Not sure what caused it - but when converted to PDF it all looked normal. Hopefully you won't have the same trouble on your end.

And noted re the updates to the 'ticked and unticked' Actual comments. It shouldn't take too long to update once the app is changed.

emily-humphreys commented 2 years ago

Beautiful - thank you for all of this.

Please send through the invoice so I can process the payment ASAP

On Sat, Jun 18, 2022 at 5:02 PM SishaMish @.***> wrote:

@emily-humphreys https://github.com/emily-humphreys

The SDGs Report Explainers are all attached. Also noticed some wording that needed updating on that page that I had missed. I put the PDFs in to the SDGs screenshot folder.

I'll also email the word docs to you. I had some trouble reading them in Word on my end - something odd happened with the formatting of the text. Not sure what caused it - but when converted to PDF it all looked normal. Hopefully you won't have the same trouble on your end.

And noted re the updates to the 'ticked and unticked' Actual comments. It shouldn't take too long to update once the app is changed.

— Reply to this email directly, view it on GitHub https://github.com/ferrisoxide/wicked_software/issues/724#issuecomment-1159385490, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADFVZOTPXYTX3LNKR44YAHLVPV3QLANCNFSM5SHP63XQ . You are receiving this because you were mentioned.Message ID: @.***>

emily-humphreys commented 1 year ago

Thank you! This is wonderful.

Great you are starting the SDGs - perhaps just hold off for one moment. We just got word from the UN that we can't use the icons for commercial use so I have developed new cards to insert in. Unfortunately, that means I'll have to get Tom to update them (sorry Tom). When this is done I will let you know so you can crack on with the screenshots.

On Thu, Apr 21, 2022 at 1:29 PM SishaMish @.***> wrote:

The last two screenshots to do are the import error pages on user guide page 7 and on page 10.

The broken links are all the links to other pages in the user guide. I've looked up how to add hyperlinks to text, but I don't know the URL of the pages I'm linking to or how to find that out. These links appear on pages 1, 3, 4, 7, 10 and 13 as underlined text.

The other things are the links to downloadable content ie. templates etc. As I have moved text and buttons around, I'm unsure if these links are still working. Will have to investigate!

I haven't looked at the SDG Alignment Card page yet - will get on to that soon.

— Reply to this email directly, view it on GitHub https://github.com/ferrisoxide/wicked_software/issues/724#issuecomment-1104682288, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADFVZOUQU57HPPBLVLKGIKTVGDHATANCNFSM5SHP63XQ . You are receiving this because you were mentioned.Message ID: @.***>

emily-humphreys commented 1 year ago

Great pick up! Yes, you are right we need to update those and potential points to the "assigning a status to comment https://www.wickedlab.co/subsystems-tags" rather than rewriting the explanations.

What do you think?

On Fri, Apr 29, 2022 at 1:30 PM SishaMish @.***> wrote:

@emily-humphreys https://github.com/emily-humphreys

Hi Emily. I've just realised while replicating the 'Mapping Initiatives' page to adapt it to an SDGs version, that there is probably some key points missing from the original page. In Section 1. on that page, there is no mention of tagging comments as 'Actual' 'Planned' etc. It only mentions that once the comment is completed and saved the text will turn blue. I am assuming that users are not just going to be marking all comments as 'Actual' every time, and that this is a place that requires some explanation of the different statuses that comments can have, and therefore the different coloured text that can appear after saving. Is that correct?

i just want to clarify that with you before i start making a major change here.

— Reply to this email directly, view it on GitHub https://github.com/ferrisoxide/wicked_software/issues/724#issuecomment-1112854893, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADFVZOXCXRMEPXMOG64T7W3VHNNGZANCNFSM5SHP63XQ . You are receiving this because you were mentioned.Message ID: @.***>