Xiaoxing Ye wrote:

Hi Ariessa,

May I know what do you mean by a documentation guideline? And what part of the doc is informal? Perhaps a page that explains how the documentation for Mailman should be written. For example, every documentation page must have an introduction section or frequently-asked questions. Or, a page that explains the preferred style of documentation such as no contractions, use active voice over passive voice and etc.

Example: https://www.drupal.org/drupalorg/style-guide/content

Also, for different kind of audience, the style might differ.

I see.

Yours truly, Xiaoxing Ye

On Tue, Jun 11, 2019 at 11:43 PM

...

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

---

Mailman-Developers mailing list -- mailman-developers(a)python.org To unsubscribe send an email to mailman-developers-leave(a)python.org https://mail.python.org/mailman3/lists/mailman-developers.python.org/ Mailman FAQ: https://wiki.list.org/x/AgA3

Security Policy: https://wiki.list.org/x/QIA9

Abhilash Raj wrote:

On Tue, Jun 11, 2019, at 8:42 AM, ariessa.norramli(a)gmail.com wrote:

...

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? 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.

...

Thank you.

Best Regards, Ariessa

---

Mailman-Developers mailing list -- mailman-developers(a)python.org To unsubscribe send an email to mailman-developers-leave(a)python.org https://mail.python.org/mailman3/lists/mailman-developers.python.org/ Mailman FAQ: https://wiki.list.org/x/AgA3

Security Policy: https://wiki.list.org/x/QIA9

Understood. Thank you for the reply.

Best Regards, Ariessa