Spekit Label: name of the Spek-whatever is likely to be most searched by a teammate
Definition: this is where the main content of the Spek is entered, so it should be concise, bite-sized information for a teammate to easily access and understand
Include links to other relevant Speks at the beginning, and use the Speki icon 🐙 to visually represent related Speks
Heading: use only when structuring the Spek to potentially show how to do a task in two different ways
Insert Images, GIFs, and Videos before the text steps
An image says a thousand words, because showing someone is easier than telling them
Use bold for key object names, buttons, or picklist values
Text within numbered steps or lists (1, 2, 3) and text following bullet points should not have a period at the end, as they are oftentimes not full sentences
- Use numbers for steps
- If images are used in between numbered steps, you will have to manually number and indent the next step number
- Use Bullets for list items
Capitalization: capitalize proper nouns such as Salesforce field names or product and feature names; type common nouns in lower case
Note: notes should be italicized and only Notes should be in bold at the beginning. The same goes for Examples and Best Practices
Resources: Include files to job aids, links to other resource documents or web pages, etc.
Format Example Spek:
Spek 1: Salesforce Process
Spek 2: Same process, but the WRONG WAY