kumu / weavr-docs Goto Github PK

These docs look great @michellemonty! Really looking forward to having them in place and think they'll add a lot for our community, with the added benefit of hopefully lightening up the workload on the support front a bit.

Here are some suggestions to take or leave as you see fit.

Getting Started

• Break out "Create a community", "Invite your connections" and "Support" sections into a separate guide, since those sections are directed at admins. It would make sense for the home page to speak more generally to the average user IMO. If you decide to go that direction, you could add a paragraph after the app store links that says something like "Weavr communities are comprised of members and community admins. If you are a community admin looking to create or customize your community, click here." (maybe italicized).
• Create a community:
  • Mention that you have to visit weavr.app/create on a desktop to create a community (can't be done on the mobile app)
• Fill out profile
  • The icon won't have an image when the first log-in, so maybe take out the word "image": Click on the icon on the far right.."
  • For continuity with previous section, preface the first line with "Once you've created your community and logged in, click on the..." (if you break out the admin-specific stuff into a separate guide as recommended above, no need to make this edit)
  • Consider changing the third sentence to "Add a profile picture, fill out your basic info, and add your interests, offers and needs", to underscore offers/needs
• Invite your connections
  • May want to just link to the "Inviting Community Members" guide here to keep all that info in one place and make docs easier to maintain
  • First paragraph
    • I might change the first line to Click on the hamburger icon on the top-right to access the drawer menu and choose "Invite"
    • Consider adding to the end of the first paragraph: If you'd like all members of your community to be able to invite other users, visit the "Members" tab of the Edit Community page by clicking the gear icon on the community home. This won't be enabled by default.
  • Second paragraph
    • Be more specific about where to find the Edit Community link by mentioning they need to go to the community home (or whatever we're calling it). Also mention that it can be accessed from the drawer menu as well.
  • Update your relationships
    • Consider adding to the italicized paragraph at the end that a relationship you add will show up on the other user's profile, even if they haven't added you as a relationship

Billing

• 4th paragraph
  • "Click on the pencil icon in the top-right corner" > "Click on the gear icon in the top-right corner"
  • Missing a period after "Edit Community" and "right corner"

Inviting community Members

• The 2nd paragraph isn't entirely accurate. After adding users to import, there's a checkbox that allows the admin to send an invitation email to the invited users. It doesn't include a link to login, but it does let them know they've been invited to the community.

Messages & Post Topics

• Post topics: Only admins will have access to the Edit Topics option
• Subscribe
  • Change first line to "By default, you're not subscribed to any post topics, and only the messages posted to General will appear in your feed unless you're viewing a topic."
  • Change third line to "If any new post get added to that post topic, you'll be notified with a push or email notification, and the messages for topics you're subscribed to will also appear in your feed."

Profile Fields

• I might just rename this "Profiles"
• For "Deleting a field", I would either delete that section or instruct them to email support for now

Relationship Strengths

• Few typos in the 2nd point under "To add a new relationship"
• Default Relationship Strengths: I'd be sure to clarify that you have to be an admin to edit relationship strengths, even though you go on to mention that in the next section
• Editing Relationship Strengths: "Give a value to the relationship strength to determine how they are treated in the Network Analysis section of the Weavr app, and how relationships are ordered on user profiles."

Stuff for later

• That connections displayed on a profile prioritize the strength the profile user specified
• Profiles, and you can interact with people via the weaving button next to their profile pic
• Specific steps for integrating a community feed into a Kumu map (once created by support) in the Export guide