Skip to content

Documentation Guidelines

This Documentation Guidelines (style guide) ensures all the files in all repositories and any other documentation are properly documented.

Documentation guidelines

The purpose of this guideline is to provide a step-by-step framework for writing and maintaining high-quality documentation for Creative Commons (CC) projects. This guide covers essential sections such as project style guide Preference, Style modification, terminologies, markdown usage. Following these guidelines ensures consistency, clarity, and ease of use for all contributors and users.

Style guide reference

For general writing style and guidelines, refer to the following upstream style guides:

Style preferences modifications

While adhering to the upstream style guides, observe the following modifications:

Terminology

Establishing a clear "Terminology" section for Creative Commons (CC)-specific usage is crucial. Below are some proprietary terms and their usage:

Markdown usage

This section provides guidelines for using Markdown in documentation: