Some loose guidelines for documentation:
Screenshots:
- Full-width admin screenshots to be taken with a browser width of around 1400px
- Crop out the top ribbon (with your Partner logo, etc) unless the article is specifically referencing elements in that section.
- Only use screenshots were necessary. Unnecessary screenshots/images will only cause headaches when admin UI changes and these need to be updated. Extra images will also make site loading slower.
Videos:
- Ideally, written text documentation is preferred. Consistent videos can then be created from the written documentation as needed.
Text:
- Feel free to supply the text in any digital format you wish (Google Doc, Word file, Email⌠but not fax
) - In English please (and preferably UK spelling but I wonât be picky)
Syntax:
- Always write the full name of âTreepl CMSâ with capitals, ie: not âtreeplâ
- When referring to general Treepl CMS concepts/terms I try and use title case. eg: Partners, Secure Zones, Partner Portal.
- When referring to specific sections or actual CMS items I tend to use single quotes around the title case term. eg: âCRMâ > âContactsâ, the âSystem Propertiesâ section, or, the âSEOâ tabâŚ
- When referring to buttons or actionable elements I try to use double quotes. eg: âAdd New Itemâ, âSaveâ, âDelete
ââŚ
Links:
- Try to minimise internal documentation links if possible (as these could prove difficult to manage as the docs evolve). Instead, we try and utilise the âRelated Articlesâ section at the end of the document. Same page anchor links are ok though.
- Try to minimise external links within the article. Instead, we try to utilise the âExternal Resourcesâ section at the end of the document to avoid messy and distracting links throughout.
Submitting Contributions:
- You can post content here in the Forum or in Slack or private message me in either place as well. Or send me a link to your content. Basically any way you want to get it to me is fine
)