You are one of those guys who strive for perfection, right? If you've already looked at our Authoring Guidelines but want to go a step ahead to ensure the accuracy of your articles, see the following guidelines:
Ensuring accuracy
- At the end of your article, write the text Applicable versions and format is as Heading 2. Then, provide the versions of the Lithium platform to which the article applies to. See example
- In a new paragraph, write the text Required permissions and settings and format is as Heading 2. Then, provide the permissions and settings that a user would require to perform the instructions of the article. Also, provide information about the roles that have those settings enabled by default. See example
Ensuring value and consistency
- Add links to relevant KB articles and blog posts.
- Use bold format for all references to specific commands, button texts, and breadcrumbs
- Use tables to clarify concepts
- Use <pre></pre> tags to provide examples of code
- Use the text http://YOURCOMMUNITYURL/ as a placeholder when you want to reference community-specific URLs.
- Use the Lithosphere to provide examples of REST API calls
Since this is a Tribal KB, articles will not necessarily look equal to each other. Although consistency with the guidelines is needed, different tones or approaches to writing are acceptable. We want all users to be themselves and contribute in their own tone.
