Table of Contents
Abstract
When documenting a programming language, resource, or topic, it is best to adhere to specific conventions that ensure the following:
- Clarity within text;
- Consistency throughout documents;
- Readability throughout documents.
Documents that do not follow a set of conventions, will often times be difficult to understand from the vast audience--- which--- happens a lot more than usual. This document aims to address some of the conventions that will be used throughout every document for every programming language, topic, or resource.
Questions
A Note to Consider
Most information regarding the structure and organization of documents can be found at this link: Markdown style guide
Quick Notes
Adhering to documentation conventions and using templates will significantly improve the quality and consistency of each document. You will always be able to contact other maintainers, to ensure that the document you are creating is accurate, comprehensive, and valuable.
Note: Some documents will be ignored or altered without notifying you, this is only done by maintainers.