Creative Common Technical Documentation Guideline page added

content/blog/authors/Dev-JoyA/contents.lr

@@ -0,0 +1,10 @@
+username: Dev-JoyA
+---
+name: Joy Aruku
+---
+md5_hashed_email: 
+---
+about:
+Joy Aruku is a MERN stack web developer based in Lagos, Nigeria.
+
+

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

@@ -0,0 +1,139 @@
+_model: page
+---
+_template: page-with-toc.html
+---
+title: Technical Documentation Guidelines
+---
+description: This Technical documentaion guidelines (style guide) ensuures all the readme on all repository and any other technical docs are properly documented .
+---
+body:
+
+## Technical Documentation Guidelines
+The purpose of this guideline is to provide a step-by-step framework for writing and maintaining high-quality technical documentation for Creative Commons (CC) projects. This guide covers essential sections that should be included in the documentation, such as project overview, code of conduct, contributing instructions, installation, development, and deployment. Following these guidelines will ensure 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]: (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, the following modifications should be observed:
+
+- Use active voice wherever possible to improve clarity and engagement.
+- Keep sentences concise and to the point, avoiding jargon unless necessary.
+
+## Overview 
+
+The Overview section provides a summary of the project and general information that users or contributors need to know. It should include 
+
+- Repository information: Include the link to the GitHub repository and a brief description of the project.
+- Tech stack: List the technologies used to build the project (e.g., Python, Django, Jekyll, JavaScript).
+
+## Code of conduct
+The Code of Conduct section ensures that all contributors are aware of the community standards and acceptable behavior. It should include
+
+- A brief statement referring to the project's code of conduct
+- A link to the full CODE_OF_CONDUCT.md file in the repository
+- Information on how to report issues or violations.
+[org-coc]: https://github.com/creativecommons/.github/blob/main/CODE_OF_CONDUCT.md
+[code_of_conduct]: https://opensource.creativecommons.org/community/code-of-conduct/
+[reporting_guide]: https://opensource.creativecommons.org/community/code-of-conduct/enforcement/
+
+## Contributing
+The Contributing section provides details for those who wish to contribute to the project, and ensuring they follow the right process.
+
+- A link to the contribution guideline file in the repository.
+- GitHub Pull Request (PR) guidelines.
+- Link to repository guideline
+[Contribution guideline] : https://opensource.creativecommons.org/contributing-code/
+[GitHub PR guideline]: https://opensource.creativecommons.org/contributing-code/pr-guidelines/
+[Repository guideline]: https://opensource.creativecommons.org/contributing-code/github-repo-guidelines/
+
+
+## Installation
+The Installation section guides users through setting up the project on their local machines.
+
+- A list of prerequisites
+- A detailed step-by-step instructions on how to install the necessary dependencies and tools.
+- Instructions on how to clone the repository and set up the environment.
+
+### Development
+
+The **Development** section provides detailed instructions for contributors on how to run and develop the project locally.
+
+**What to include:**
+- Instructions on how to start the local development environment.
+- Steps for running the project and viewing changes.
+- Any necessary setup (e.g., database, environment variables).
+
+### Deployment
+
+The **Deployment** section includes the steps needed to deploy the application.
+
+**What to include:**
+- Deployment prerequisites (if any).
+- Step-by-step instructions for deploying the project to the production environment.
+- Configuration details for cloud services or hosting providers (e.g., GitHub Pages, AWS). if any
+
+### Markdown Syntax Usage
+
+This section offers guidance on how to use Markdown effectively in documentation.
+
+**Basic Syntax:**
+- **Headings**: Use `#` for headings and additional `#` symbols for subheadings.
+   ```markdown
+
+   # Heading 1
+   ## Heading 2
+   ### Heading 3
+
+Lists:
+
+Unordered list:
+markdown
+
+- First item
+- Second item
+
+Ordered list:
+markdown
+
+1. First item
+2. Second item
+
+Links:
+markdown
+
+[Link](url)
+
+Images:
+markdown
+
+![Alt Text](url)
+
+Code Blocks:
+markdown
+        ```
+        code command 
+        ```
+
+Tables:
+markdown
+
+| Header 1 | Header 2 |
+|----------|----------|
+| Content 1 | Content 2 |
+
+
+## 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 that enables 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, which is a requirement in many CC licenses.
+
+Note : use the code Block markdon for instruction on installation, deployment, and development ... especially to write code commands