Skip to content
This repository has been archived by the owner on May 28, 2022. It is now read-only.

Adopt a documentation style guide #105

Open
yamgent opened this issue May 24, 2018 · 1 comment
Open

Adopt a documentation style guide #105

yamgent opened this issue May 24, 2018 · 1 comment

Comments

@yamgent
Copy link
Contributor

yamgent commented May 24, 2018

We have adopted standards for our coding style, but we do not have a guide for our documentation style.

We can consider adopting a documentation style guide for our open source projects such that the readers of our documentation (both users and developers) have an easier time reading them.

We can either write our own by taking the concepts from CS2101, such as passive voice, second person, conciseness and consistencies. Alternatively we can also adopt wholesale the guides from other open source projects, such as Google's one: https://developers.google.com/style/. The one by Google seems to be pretty useful as it also delves into the concepts that I have mentioned earlier.

@damithc
Copy link
Contributor

damithc commented May 25, 2018

Good idea @yamgent
Google guide looks good.
Do a PR to add it when you have time.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants