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

Adopt a documentation style guide #105

Description

@yamgent

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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions