Concept
User-facing documentation for Community OS: guides, concepts, references, and technical material.
By type
Concept
- What are the shared foundation types?
- What are the reports?
- What is a campaign?
- What is a consultation?
- What is a referral?
- What is a story?
- What is a survey?
- What is advocacy?
- What is an attendance record?
- What is an event?
- What is an RSVP?
- What is feedback?
- What is messaging?
- What is the community CRM?
- What is the community graph?
- What is the directory?
- What is the provider portal?
- What is the volunteer hub?
- What is a trustee
- What is delegated authority
- What is consent
- What is a support arrangement
- What is a DID
By domain
All docs
- What are the shared foundation types?Concept
The common foundation is not an app. It is the shared layer that every other domain builds on. It provides the base types that other records reuse, such as people, organizations, events, and addresses. It also provides the codelists that keep data consistent, such as languages, regions, and accessibility preferences.
- What are the reports?Concept
The reports are summaries of community activity and wellbeing. Each report covers a period and records when it was generated.
- What is a campaign?Concept
A campaign is a planned outreach effort. It has a name, the channels it uses, start and end dates, a target audience, and a budget.
- What is a consultation?Concept
A consultation is a formal way to ask the community what it thinks about a topic. It has a title, a sponsoring organisation, a closing date, and one or more questions.
- What is a referral?Concept
A referral connects a person with a service provider. The referral records who is being referred, who made the referral, what the person needs, and which provider was recommended.
- What is a story?Concept
A story is a community member's account of their experience. Each story records the person, a title, and the content of what they shared. Stories can include media, such as a photo, audio, a video, or text.
- What is a survey?Concept
A survey is a set of structured questions sent to a group of people. Each survey has a title and a list of questions. Questions can be short answer, multiple choice, or rating.
- What is advocacy?Concept
Advocacy is support for a person who needs help with an issue. It might be a complaint, a decision that affects them, or a service that has not worked. An advocacy case is the record of that support.
- What is an attendance record?Concept
An attendance record is a summary of who actually came to an event. It is different from an RSVP, which only says who planned to come.
- What is an event?Concept
An event is a scheduled gathering for the community. It can be in person or online. Each event has a title, a description, a date and time, and a location or online link.
- What is an RSVP?Concept
An RSVP is a person's reply to an event invitation. It tells the organisers whether the person plans to attend. An RSVP can be Confirmed, Pending, or Cancelled.
- What is feedback?Concept
Feedback is a record of what a community member thinks about a service, an event, or the community itself. A feedback submission can be made with a name or anonymously.
- What is messaging?Concept
Messaging is how the community sends and receives messages. It has three kinds of records:
- What is the community CRM?Concept
The community CRM is the shared contact record for your community. It stores one record per person. Each record holds the person's name, contact methods, accessibility preferences, tags, and a history of notes.
- What is the community graph?Concept
The community graph maps the connections between people in the community. It keeps three kinds of records:
- What is the directory?Concept
The community directory is a searchable list of the people, organizations, and support workers in the community. Each entry points to a person or an organization and carries categories, searchable keywords, and a region.
- What is the provider portal?Concept
The provider portal is the space where a service organization connects with the community. Each portal links an organization to the events it publishes and the resources it shares.
- What is the volunteer hub?Concept
The volunteer hub connects people who want to volunteer with opportunities that need help. It keeps three kinds of records:
- What is a trusteeConcept
A trustee is a person a beneficiary trusts to act for them within set limits. The beneficiary chooses their trustees. A trustee is not an employee and not a stranger. A trustee is someone the beneficiary knows and relies on.
- What is delegated authorityConcept
Delegated authority is the power a beneficiary gives a trustee to act for them. The beneficiary decides the limits. The trustee acts only within those limits.
- What is consentConcept
Consent is a beneficiary's permission for someone or an app to access a collection of their records. It is the beneficiary's choice, recorded in a consent grant. It is never assumed and never implied.
- What is a support arrangementConcept
A support arrangement is the record that assigns a support worker to a beneficiary for a set period. It makes the working relationship formal and time-bound.
- What is a DIDConcept
A DID is a Decentralized Identifier. It is the permanent digital address of a person, an organization, or a service in Community OS. Every record that names someone uses a DID.