Merge pull request #823 from Dev-JoyA/blog/technical-documentation-guideline

Creative Common Technical Documentation Guideline page added

Author: TimidRobot

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

@@ -0,0 +1,43 @@
+_model: page
+---
+_template: page-with-toc.html
+---
+title: Documentation Guidelines
+---
+description: This Documentation Guidelines (style guide) ensures all the files in all repositories and any other documentation are properly documented.
+---
+body:
+
+# 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:
+
+- [Google Developer Style Guide (Preferred)](https://developers.google.com/style/)
+- [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/)
+
+## Style preferences modifications
+
+While adhering to the upstream style guides, observe the following modifications:
+- All acronyms must be defined on first use
+- Use active voice wherever possible to improve clarity and engagement.
+- Keep sentences concise and to the point, avoiding jargon unless necessary.
+
+
+## Terminology
+
+Establishing a clear "Terminology" section for Creative Commons (CC)-specific usage is crucial. Below are some proprietary terms and their usage:
+
+- **Creative Commons (CC)**: A non-profit organization enabling sharing and reuse of creative works.
+- **Licenses**: Legal tools that allow creators to specify how their works can be used.
+- **Attribution**: Giving credit to the creator of a work, required by most CC licenses.
+
+
+## Markdown usage
+This section provides guidelines for using Markdown in documentation:
+- For comprehensive documentation on GitHub-flavored Markdown, refer to the [GitHub Markdown Guide](https://docs.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax).
+- For additional information on the specific Markdown implementation used in Lektor, visit the [Lektor Markdown Documentation](https://www.getlektor.com/docs/content/#markdown).
+- Note: Use code block markup for instructions on installation, deployment, and development, especially to write code commands.

themes/vocabulary_theme/templates/layout.html

@@ -79,6 +79,7 @@
                 ['/contributing-code/github-repo-guidelines', 'GitHub Repo Guidelines'],
                 ['/contributing-code/repo-labels', 'Repository Labels'],
                 ['/contributing-code/foundational-tech', 'Foundational technologies'],
+                ['/contributing-code/documentation-guidelines', 'Documentation Guidelines'],
                 ['/contributing-code/javascript-guidelines', 'JavaScript Guidelines'],
                 ['/contributing-code/python-guidelines', 'Python Guidelines'],
                 ['/contributing-code/translation-guide', 'Translation Guide'],

themes/vocabulary_theme/templates/page-with-toc.html

@@ -30,9 +30,11 @@ <h1>{{ this.title }}</h1>
                     {% if (href == '/contributing-code') %}
                       <ul>
                       {% for href, title in [
+                        ['/contributing-code/foundational-tech', 'Foundational technologies'],
                         ['/contributing-code/pr-guidelines', 'Pull Request Guidelines'],
                         ['/contributing-code/github-repo-guidelines', 'GitHub Repo Guidelines'],
                         ['/contributing-code/repo-labels', 'Repository Labels'],
+                        ['/contributing-code/documentation-guidelines', 'Documentation Guidelines'],
                         ['/contributing-code/javascript-guidelines', 'JavaScript Guidelines'],
                         ['/contributing-code/python-guidelines', 'Python Guidelines'],
                         ['/contributing-code/translation-guide', 'Translation Guide'],