Skip to content

Commit a383489

Browse files
committed
Removed README from documentaion-guidelines
1 parent 89c4b02 commit a383489

File tree

2 files changed

+30
-81
lines changed

2 files changed

+30
-81
lines changed

content/contributing-code/documentation-guidelines/contents.lr

+30
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,34 @@
11
title: Documentation Guidelines
2+
description: This Documentation Guidelines (style guide) ensures all the files in all repositories and any other documentation are properly documented.
3+
4+
---
5+
# Documentation Guidelines
6+
7+
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.
8+
9+
## Style Guide Reference
10+
11+
For general writing style and guidelines, refer to the following upstream style guides:
12+
13+
- [Google Developer Style Guide (Preferred)](https://developers.google.com/style/)
14+
- [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/)
15+
16+
## Style Preferences Modifications
17+
18+
While adhering to the upstream style guides, observe the following modifications:
19+
- All acronyms must be defined on first use
20+
- Use active voice wherever possible to improve clarity and engagement.
21+
- Keep sentences concise and to the point, avoiding jargon unless necessary.
22+
23+
24+
## Terminology
25+
26+
Establishing a clear "Terminology" section for Creative Commons (CC)-specific usage is crucial. Below are some proprietary terms and their usage:
27+
28+
- **Creative Commons (CC)**: A non-profit organization enabling sharing and reuse of creative works.
29+
- **Licenses**: Legal tools that allow creators to specify how their works can be used.
30+
- **Attribution**: Giving credit to the creator of a work, required in many CC licenses.
31+
232

333

434
- ### Markdown Usage

content/contributing-code/technical-docs-guidelines/contents.lr

-81
This file was deleted.

0 commit comments

Comments
 (0)