How to: Write a tip for the Community

Checkfront Community Tips are posts by our very knowledgable Community members (that's you!) and the Checkfront team to share our knowledge with other Community members. These posts can include:

Workflows
Configurations
Customizations
Solutions
How to utilize features
Best practices
and plenty more!

Helpful and well-written tips may be featured as a pinned post, or be made into an official knowledge-base article! Share and demonstrate your expertise by providing others with some great tips.

What to include

Not sure what to add to your tip? Here are a few suggestions to get you started in the right direction:

What was the problem or issue that you found a solution for?

Including the problem or issue that you faced provides a helpful overview and the real-world context that readers can empathize with. This way, your readers can compare their situation to your own and continue reading to learn more.

Things to consider for this section:

Describe how the challenge first occurred. What were you trying to overcome?
Give an explanation of how the issue affected your workflow.

What is your solution to the problem?

Once the problem or issue that you ran into has been described, you can then describe how you overcame that issue. The solution is a good basis for your title.

Things you may want to add for the solution:

Provide a short description of the solution. This section should only define the solution briefly. The following section will describe how to implement it.
Explain why the solution worked for you and your business type.

What are the steps to implement your solution?

After you define your solution, you can then instruct readers on how to implement the solution. These steps are most effective when they are numbered and sequential.

See below for some Pro tips on writing out tips!

Pro tips for writing out a Tip or Best Practice for the community!

Use a clear and descriptive title. By using progressive verbs such as "Creating" or statements like "How to", you’ll be able to capture readers' attention.
Use sections to add structure. Breaking your tip into a few sections makes it easier to read and encourages people to not skim over the text.

Separate your sections with Headers. Provide more context to readers with headings as they read each section.

To add headings
1. Select the text you want to make a heading.
2. Click the header icon (T) at the top of the Details box.
3. Choose the heading level that you would like to use.
Take it step-by-step. When writing a tip that has many steps, try to use numbered steps. This way, other Community members will find it easier to follow along.
Link to a help article related to your tip. Including links to help documentation will provide readers with more context if there are just starting out with Checkfront.
Add some screenshots. Make it easier for the reader to follow along, by adding screenshots to orient them. Screenshots should not be larger than 600 pixels or smaller than 300 pixels.

Here are some relevant 'How To' posts to get started!