Guide
User-facing documentation for Community OS: guides, concepts, references, and technical material.
By type
Guide
- Collect and review feedback
- Confirm registrations and check-ins
- Create and distribute a survey
- Manage an advocacy case
- Manage people in the community
- Match volunteers with opportunities
- Plan and measure a campaign
- Publish a community story
- Publish and manage events
- Run a community consultation
- Send notifications and broadcasts
- Track a referral
- Track event attendance
- Use the community directory
- Use the provider portal
- View reports on the community
- View trust connections and ambassadors
- What is Community OS
- Create your identity
- Sign in
- Become a trustee
- Accept an invitation
- Delegate authority
- Grant consent
- Set up a support arrangement
- Access a support plan
- Review and revoke consent
- Resign as a trustee
By domain
All docs
- Collect and review feedbackGuide
Feedback tells you how the community experiences your services. This guide shows you how to receive feedback, review it, and decide what needs to happen next.
- Confirm registrations and check-insGuide
Registrations tell you who plans to come. This guide shows you how to confirm RSVPs, manage the waitlist, and record check-ins so you know who is at the event. You can also record accessibility requests so the event is welcoming for everyone.
- Create and distribute a surveyGuide
A survey collects structured answers from a group of people. This guide shows you how to create a survey, add questions, publish it, and review the responses.
- Manage an advocacy caseGuide
An advocacy case supports a person who needs help with an issue, such as a complaint or a decision that affects them. This guide shows you how to open a case, keep it up to date, and record how it was resolved.
- Manage people in the communityGuide
The community CRM is the central record of every person in your community. This guide shows you how to create a person record, keep it accurate, and add notes over time. A good record makes it easy to find someone, understand their needs, and coordinate support.
- Match volunteers with opportunitiesGuide
The volunteer hub matches people who want to help with roles that need filling. This guide shows you how to keep volunteer profiles current, publish opportunities, and review the best matches.
- Plan and measure a campaignGuide
A campaign reaches out to the community for a goal, such as more event sign-ups or more members. This guide shows you how to plan a campaign, record its details, and measure its results.
- Publish a community storyGuide
Stories share the experiences of community members. This guide shows you how to record a story, add photos or audio with consent, and publish it so others can read it.
- Publish and manage eventsGuide
Events bring the community together. This guide shows you how to publish an event so people can see it and register. You will create the event, add the details, publish it, and keep it accurate while people sign up.
- Run a community consultationGuide
A consultation asks the community what it thinks about an issue before a decision is made. This guide shows you how to run a consultation from start to finish: publish the question, collect responses, group the answers into themes, and share the outcome.
- Send notifications and broadcastsGuide
Messaging keeps the community informed. This guide shows you how to send a notification to one person, send a broadcast to a group, and help people control the messages they receive.
- Track a referralGuide
A referral connects a person with the services they need. This guide shows you how to record a referral, choose a provider, update its status, and record the outcome so nothing is left hanging.
- Track event attendanceGuide
Attendance records show who came to an event. This guide shows you how to build an attendance record for an event, count who arrived, and record who did not show up. Accurate attendance helps you plan better events and report on how many people the community reached.
- Use the community directoryGuide
The community directory helps you find people, organizations, and support workers. This guide shows you how to search the directory, narrow results, and open a record to get the details you need.
- Use the provider portalGuide
The provider portal is the space where a service organization connects with the community. This guide shows you how to set up a portal, add published events and shared resources, and manage the provider's permissions.
- View reports on the communityGuide
Reports show how the community is doing. This guide shows you how to open each report, understand what it measures, and use the numbers to make decisions.
- View trust connections and ambassadorsGuide
The community graph maps how people are connected. This guide shows you how to view relationships and trust connections between people, and how to review ambassador activity so you can strengthen the community's reach.
- What is Community OSGuide
Community OS is the online home of a trust network. A trust network is a group of people who work together so one person can get the support they need. The person at the centre is called the beneficiary. Everyone else in the network acts only with the beneficiary's permission.
- Create your identityGuide
Your identity in Community OS is a permanent digital address called a DID. Short for Decentralized Identifier. Think of it as your address on the trust network. You create it once, and you keep it for life. It never changes.
- Sign inGuide
Signing in to Community OS uses a magic link. A magic link is a sign-in link sent to your email address. You select the link, and Community OS opens with you signed in. There is no password to remember.
- Become a trusteeGuide
A beneficiary chooses the people they trust. When Wiremu chooses Hana to act for him, Hana becomes a trustee. A trustee acts for the beneficiary within set limits, called a scope. The scope names the records the trustee may work with, such as the support plan.
- Accept an invitationGuide
A beneficiary who wants you to act for them sends you an invitation. The invitation names you as a delegate on a delegation record. Accepting the invitation makes you a trustee. You are not required to accept. You decide.
- Delegate authorityGuide
Delegating authority means giving a trustee the power to act for you on a scope of records. A scope names the records, such as your support plan. You choose the trustee, the scope, and the dates. You keep control. A delegation alone does not let the trustee see anything. Your consent is always needed too.
- Grant consentGuide
Consent is your permission for someone or an app to access a collection of your records. A collection is a set of records, such as your support plan. You choose who gets access and at what level. Read means they can view. Write means they can view and change.
- Set up a support arrangementGuide
A support arrangement is the record that assigns a support worker to a beneficiary for a set period. It names the beneficiary, the support worker, the organization, and the role. It has a start date, an end date, and a status.
- Access a support planGuide
A support plan is the beneficiary's record of their goals, preferences, services, and appointments. Examples of preferences are accessibility needs such as braille. Examples of services are personal care.
- Review and revoke consentGuide
Consent is your permission for someone or an app to access a collection of your records. You can review your consent grants at any time. You can revoke one to stop access. Revoking consent stops access immediately.
- Resign as a trusteeGuide
As a trustee you act for a beneficiary within set limits. You are not forced to keep the role. You can resign at any time. Resigning means ending your delegation. After you resign, the delegation is revoked and you lose access to the beneficiary's records.