We need to write knowledge-base articles so that people who use Voluntarily can find help themselves before asking. There are three main categories that we are creating within
Instructions
In your browser, navigate to: voluntarily.atlassian.net/wiki/spaces/VSP/overview
On the left panel, select the article type:
About Voluntarily - why we do what we do - e.g. why are we collecting information about hobbies? why are we collecting someone’s pronouns?
Troubleshooting articles - How to do certain things on the platform - e.g. I forgot my password
How-
...
to articles - Curated best practice from around the globe on the topics that Voluntarily users are asking for help on
...
Instructions
...
.
...
On the left panel, select the article type:
About Voluntarily - helpful information about Voluntarily
Troubleshooting articles - provide solutions to problems or help with analysis
How-to articles - Use a how-to article to provide step-by-step instructions to complete a task or answer a question. Keep your how-to articles organised in a Knowledge Base space.
If you are creating an “About Voluntarily” article:
...
Type your answer, type / (forward slash) to add images, gifs, and other cool things . to make it fun
...
Select Publish (upper right of screen)
...
Put your name in and click Create, finish it off by clicking on Publish.
You can use a tool like LiceCap to record short screen grabs to show what you mean. Sometimes it’s easier that a bunch of still screenshots. (see how we did it in the “How to add gif” above - how meta!
If you are creating a “How-To” article:
...
Click on that, and you will get a pop-up which will lead you through the rest.
You can type / (forward slash) to add images, gifs, and other cool things to make it fun
...
No matter what type of article you have written, test whether your article can be found in a search at the customer portal:
...