Style Guide: Difference between revisions
m Remove note about Plesk 'Dynamic List' view as it is now deprecated |
m Add preferred server listing order & use H2 headers for better readability |
||
| Line 1: | Line 1: | ||
= Style Guide = | == Style Guide == | ||
We welcome contributions to our community powered Wiki. Please see our documentation style guidelines below, created to help maintain consistency across user guidance documentation. | We welcome contributions to our community powered Wiki. Please see our documentation style guidelines below, created to help maintain consistency across user guidance documentation. | ||
= Writing Language = | == Writing Language == | ||
American English is used for consistency, and the writing tone is friendly and professional. | American English is used for consistency, and the writing tone is friendly and professional. | ||
| Line 9: | Line 9: | ||
Please proofread for spelling, grammar, and capitalization before submitting a contribution for review. | Please proofread for spelling, grammar, and capitalization before submitting a contribution for review. | ||
= User-focused Guidance = | == User-focused Guidance == | ||
Users may access the Wiki from desktop, mobile, or other devices. Where possible, providing guidance on a single page for a specific support topic is preferred, ensuring users do not have to click through to different pages unnecessarily. | Users may access the Wiki from desktop, mobile, or other devices. Where possible, providing guidance on a single page for a specific support topic is preferred, ensuring users do not have to click through to different pages unnecessarily. | ||
| Line 19: | Line 19: | ||
Wiki content is intended to be shared between users helping each other in line with our community powered support model. This means that tutorials for a specific Plesk feature or coding language should ideally be detailed on one page. This will create a single weblink with support or guidance that can easily be shared with users asking for help. | Wiki content is intended to be shared between users helping each other in line with our community powered support model. This means that tutorials for a specific Plesk feature or coding language should ideally be detailed on one page. This will create a single weblink with support or guidance that can easily be shared with users asking for help. | ||
= HelioHost and HelioNet Links = | == HelioHost and HelioNet Links == | ||
Please use 'https' and no leading 'www' when linking to [https://heliohost.org/ https://heliohost.org] or [https://helionet.org/ https://helionet.org]. | Please use 'https' and no leading 'www' when linking to [https://heliohost.org/ https://heliohost.org] or [https://helionet.org/ https://helionet.org]. | ||
| Line 25: | Line 25: | ||
Older links that have the 'www' will still work with an extra redirect, but this format should no longer be used. | Older links that have the 'www' will still work with an extra redirect, but this format should no longer be used. | ||
= Users = | == Servers == | ||
When listing servers, it's preferred to list the best one first, so the order would be: Morty, Tommy, then Johnny. | |||
== Users == | |||
Generally, guidance would be targeted to 'users', which covers our free users and donor users. | Generally, guidance would be targeted to 'users', which covers our free users and donor users. | ||
| Line 31: | Line 35: | ||
For information specific to the Morty server or VPS services, the term 'customers' can be used however this is not a firm requirement. | For information specific to the Morty server or VPS services, the term 'customers' can be used however this is not a firm requirement. | ||
= Cron Job(s) = | == Cron Job(s) == | ||
The agreed convention is to include a space between both words. Plesk calls them 'Scheduled Tasks', but users may be less familiar with this term. | The agreed convention is to include a space between both words. Plesk calls them 'Scheduled Tasks', but users may be less familiar with this term. | ||
= Screenshot Policy = | == Screenshot Policy == | ||
Screenshots are a great addition where appropriate. When using screenshots taken from within your own account, please erase any personal data you do not want published. | Screenshots are a great addition where appropriate. When using screenshots taken from within your own account, please erase any personal data you do not want published. | ||
| Line 41: | Line 45: | ||
The existing convention for Plesk is to take screenshots in Light Mode and to use a red rectangle outline border to highlight important sections. | The existing convention for Plesk is to take screenshots in Light Mode and to use a red rectangle outline border to highlight important sections. | ||
= Brand Names = | == Brand Names == | ||
Please follow brand preferences for name capitalization: Word'''P'''ress, Git'''H'''ub, Helio'''H'''ost, etc. If in doubt, refer to the brand website for guidance. | Please follow brand preferences for name capitalization: Word'''P'''ress, Git'''H'''ub, Helio'''H'''ost, etc. If in doubt, refer to the brand website for guidance. | ||
= Further Guidance = | == Further Guidance == | ||
This guidance document is dynamic and will be updated as needed to ensure that everyone feels confident about adding contributions to our Wiki. | This guidance document is dynamic and will be updated as needed to ensure that everyone feels confident about adding contributions to our Wiki. | ||
= Thank You = | == Thank You == | ||
We are community powered, which means everyone is welcome to contribute. Thank you for helping us keep improving! | We are community powered, which means everyone is welcome to contribute. Thank you for helping us keep improving! | ||
Latest revision as of 18:17, 17 January 2025
Style Guide
We welcome contributions to our community powered Wiki. Please see our documentation style guidelines below, created to help maintain consistency across user guidance documentation.
Writing Language
American English is used for consistency, and the writing tone is friendly and professional.
Please proofread for spelling, grammar, and capitalization before submitting a contribution for review.
User-focused Guidance
Users may access the Wiki from desktop, mobile, or other devices. Where possible, providing guidance on a single page for a specific support topic is preferred, ensuring users do not have to click through to different pages unnecessarily.
Users will have varying levels of technical knowledge, so the guidance provided should be accessible to a wide audience.
Users may prefer to translate the Wiki content into a language they are more comfortable with, so slang or jargon should be avoided.
Wiki content is intended to be shared between users helping each other in line with our community powered support model. This means that tutorials for a specific Plesk feature or coding language should ideally be detailed on one page. This will create a single weblink with support or guidance that can easily be shared with users asking for help.
HelioHost and HelioNet Links
Please use 'https' and no leading 'www' when linking to https://heliohost.org or https://helionet.org.
Older links that have the 'www' will still work with an extra redirect, but this format should no longer be used.
Servers
When listing servers, it's preferred to list the best one first, so the order would be: Morty, Tommy, then Johnny.
Users
Generally, guidance would be targeted to 'users', which covers our free users and donor users.
For information specific to the Morty server or VPS services, the term 'customers' can be used however this is not a firm requirement.
Cron Job(s)
The agreed convention is to include a space between both words. Plesk calls them 'Scheduled Tasks', but users may be less familiar with this term.
Screenshot Policy
Screenshots are a great addition where appropriate. When using screenshots taken from within your own account, please erase any personal data you do not want published.
The existing convention for Plesk is to take screenshots in Light Mode and to use a red rectangle outline border to highlight important sections.
Brand Names
Please follow brand preferences for name capitalization: WordPress, GitHub, HelioHost, etc. If in doubt, refer to the brand website for guidance.
Further Guidance
This guidance document is dynamic and will be updated as needed to ensure that everyone feels confident about adding contributions to our Wiki.
Thank You
We are community powered, which means everyone is welcome to contribute. Thank you for helping us keep improving!