Guide to Posting Tips
PinnedCommunity tips are posts by Stison users that share specific workflows or ways of using the system. They provide the community with problem solutions, unique ways to use features, and best or new practices.
Below are some general guidelines for writing your tip:
- Break your tip into different sections.Dividing your tip into sections increases readability and prevents readers from skimming over text. The sample sections in this article provide ideas on how to break up your tip.
- Add headings to your sections.Headings give readers context to the section before they begin reading.
To add headings
- Select the text you want to make a heading.
- Click the paragraph icon at the top of the Details box.
- Choose the appropriate heading level from the pick-list.
Your text will now be displayed as the selected heading.
- Title your post with a clear descriptionof what your readers will learn. Beginning with progressive verbs like "Creating" or statements like "How to" are good ways to capture readers' attention.
- Link documentationrelated to your tip. Including documentation can help guide readers with different levels of background knowledge.
- Include step-by-step instructions.Using numbered steps will make it easier for other users to implement your tip.
- Include screenshots.Screenshots help orient the reader and make it easier to follow along. They should not be larger than 600 pixels or smaller than 300 pixels. This is to accommodate the end-user layout.
What to include in your tip
The following sections can be used when writing your tip.
What is the challenge or problem you faced?
This section provides a useful introduction or overview while keeping your tip in real-world context. Your readers can compare their situation to your own.
Content to consider for this section:
- Describe how the problem originally occurred. What were you trying to accomplish before this problem or challenge happened?
- Explain how the problem or challenge affected your workflow.
What is your solution?
After you discuss the challenge or problem, you can briefly describe the solution. This section is a good basis for your title.
Content to consider for this section:
- Provide a short description of the solution.This section should only define the solution. The following section will describe how to implement it
- List any exceptionsto the solutions.
- Explainwhy the solution worked for you
Thank you so much for sharing your knowledge with the Stison community!
Post is closed for comments.
Comments
0 comments