Questions Regarding the Mailman Documentation's Style
Hello everyone,
What is the preferred style for the documentation? I noticed that in some part of the documentation, there exists contractions and the documentation is written informally.
Is there a template or specific guidelines for writing documentation? If not, can I propose a new template so that further documentation can be created coherently?
Thank you.
Best Regards, Ariessa
Xiaoxing Ye wrote:
Example: https://www.drupal.org/drupalorg/style-guide/content
Also, for different kind of audience, the style might differ.
I see.
On Tue, Jun 11, 2019, at 8:42 AM, ariessa.norramli@gmail.com wrote:
There aren't strict guidelines that I know of, but it wouldn't be something we should be opposed to.
Ideally, we want something that is easy to follow and doesn't add too much "process" for non-professional or native English speakers as it would be much hard to enforce that for a Volunteer run organization such as us.
-- thanks, Abhilash Raj (maxking)
Xiaoxing Ye wrote:
Example: https://www.drupal.org/drupalorg/style-guide/content
Also, for different kind of audience, the style might differ.
I see.
On Tue, Jun 11, 2019, at 8:42 AM, ariessa.norramli@gmail.com wrote:
There aren't strict guidelines that I know of, but it wouldn't be something we should be opposed to.
Ideally, we want something that is easy to follow and doesn't add too much "process" for non-professional or native English speakers as it would be much hard to enforce that for a Volunteer run organization such as us.
-- thanks, Abhilash Raj (maxking)
participants (3)
-
Abhilash Raj -
ariessa.norramli＠gmail.com -
Xiaoxing Ye