On Tue, Jun 11, 2019, at 8:42 AM, [email protected] 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 -- [email protected] > To unsubscribe send an email to [email protected] > 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 > -- thanks, Abhilash Raj (maxking) _______________________________________________ Mailman-Developers mailing list -- [email protected] To unsubscribe send an email to [email protected] 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
