chaoss / chaoss/education

Documentation in Open Source

Open
#174 7 comments 0 reactions 2 assignees Claimed by @Dipro-cyber View on GitHub
good first issue
Dominant language
No language data
Stars
14
Forks
21
PR merge metrics
No merged PRs in 30d

Description

Description:

Overview of Documentation in open source. its important and how to write a good documentation.

**Action to Take:**
1. Write a Script - Check out the [ samples ](https://docs.google.com/document/d/1zMHxMU28yJeJSoiM_3ieQ5LCA6gVT-oOeJdpbYILjdQ/edit) and please use this [template](https://docs.google.com/document/d/1Y-664nRZHUsqq66xgNleUFsD2FaFZD925WB3rd99Urc/edit?tab=t.0)
2. Create a Slide deck - Find a sample [here](https://github.com/chaoss/education/blob/main/Submission.md), and please use this [template](https://docs.google.com/presentation/d/1JFGX1-YtMnnBkTdyveVoGHbNSlXwWy-q1X1AbvunvLI/edit?slide=id.g2d67cbed6d1_1_0#slide=id.g2d67cbed6d1_1_0)
3. Record a video - [Sample](https://github.com/chaoss/education/blob/main/Submission.md)

**Additional context**
- Kindly go through the [ReadMe.md](https://github.com/chaoss/education/blob/main/README.md) file.
- [Contributing.md ](https://github.com/chaoss/education/blob/main/Contributing.md)file contains information that will help you get started
- Choose your preferred [background](https://github.com/chaoss/education/blob/main/README.md#video-background) for your video recording. if you need one.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.