## Project abstract This project aims to improve the documentation for KEcoLab, a tool for measuring energy consumption in KDE applications. This includes enhancing existing documentation, creating new documentation on key aspects of the tool, and producing a video tutorial to guide users through the measurement process. ## Proposal **Why is it useful to KDE?** - **Improved User Experience:** Clear and accessible documentation will make KEcoLab easier to use for developers, researchers, and contributors. - **Increased Adoption:** High-quality documentation will encourage wider adoption of KEcoLab within the KDE community. - **Better Understanding:** The video will provide a visual and interactive introduction to KEcoLab, making it more accessible to users with different learning styles. **How will I do it?** **Collaboration** This project will be executed collaboratively by a team of 2-3 mentees. Each mentee will take ownership of specific aspects of the project, such as drafting documentation, conducting testing, or refining deliverables, ensuring an efficient division of tasks and maintaining consistency across all outputs. **Documentation Enhancement** 1. **Setup Guide:** Create a guide to help users start the measurement process seamlessly. 2. **Measurement Process:** Expand this section with detailed step-by-step instructions, including screenshots and troubleshooting tips. 3. **Report Structure Guide:** Document the required fields, include sample reports, and provide guidelines for interpreting key metrics. 4. **Contributing Guide:** Develop clear instructions to make it easier for new developers to contribute to KEcoLab. 5. **General Documentation:** Include an overview of KEcoLab, its purpose, benefits for developers and researchers, and its applications within the KDE ecosystem. **Video Documentation (If Required)** 1. **Enhancing Existing Video:** Add audio and a transcript to the current video for better accessibility and engagement. 2. **Dedicated Video for Report Creation:** Create a video that demonstrates the report creation process with practical examples. **Documentation and Testing** - **Regular Commits:** Commit changes regularly to the chosen documentation platform, using meaningful commit messages. - **Peer Review:** Seek feedback on the documentation and video from mentors and other developers. - **User Testing:** Conduct informal user testing with developers to gather feedback on the usability and clarity of the documentation and video. ### Timeline ### PHASE 1 - Review Existing Documentation (January 17 – January 24) #### Task 1: Initial Research & Setup - Familiarizing ourselves with the KEcoLab project and its current documentation. - Review existing resources and identify gaps in the documentation. - Research best practices for writing technical documentation and creating video tutorials. - Set up necessary tools for writing documentation and creating videos (GitLab Wiki, screen recording software, etc.). **Milestone 1**: Complete initial setup and research. --- ### PHASE 2 - Implementation of Technical Documentation (January 27 – February 14) #### Task 2: Preparing Usage Scenario Scripts Documentation - Write clear documentation on how to create and use scenario scripts (Standard, Idle, Baseline). - Provide examples and best practices for creating usage scenario scripts with tools like Xdotool. #### Task 3: CI/CD Pipeline Documentation - Document the process of setting up and running the CI/CD pipeline. #### Task 4: Eco-Certifications and Troubleshooting - Write a section on how to obtain eco-certifications like the Blue Angel. - Include a troubleshooting guide with common errors and solutions when using KEcoLab. **Milestone 2**: Complete the written documentation draft. --- ### PHASE 3 - Video Documentation Production and Remaining Technical Documentation (February 17 - February 28) #### Task 5: - Contribution guidelines for developers to contribute to the KEcoLab project. - Measurement Process documentation that includes detailed step-by-step instructions with screenshots and troubleshooting tips. #### Task 6: - (Utkarsh) -> Create Introductory Video for KEcoLab Setup - Record and edit a video that demonstrates how to set up KEcoLab from scratch, covering installation and configuration. Ensure the video is beginner-friendly and includes subtitles for accessibility. - (Shubhanshu and Roopa) -> Begin working on the quick Start Guide. #### Task 7: - Record Tutorials for Usage Scenario Scripts and CI/CD Pipeline. Create video tutorials. #### Task 8: - Draft the Report Structure Guide with required fields, sample reports, and interpretation guidelines. --- ### PHASE 4 - Review and Refinement (March 3 – March 14) #### Task 9: Review and Proofreading - Review all written documentation for clarity, accuracy, and completeness. - Ensure that all video content is polished, with clear instructions, subtitles, and helpful visuals. #### Task 10: Feedback and Revisions - Share the documentation and videos with mentors and community members for feedback. Make revisions accordingly. --- **Note (Not Mandatory):** If there is any time left after completing the primary tasks, we can focus on the following additional documentation improvements: - Adding previous measurement reports to the documentation. This could involve setting up a workflow in GitLab or updating the existing one to publish reports directly to the wiki. - Including an additional page for lab statistics, such as lab runtimes and measured applications, to provide users with more insights into KEcoLab's functionality and performance. ## Foreseen challenges 1. **Time Management:** Balancing the demands of documentation, video creation, and user testing within the given timeframe. 2. **Technical Difficulties:** Encountering technical issues with the chosen documentation platform or video editing software. 3. **Learning Curve:** Learning new tools and technologies related to documentation and video production. **Mitigation Strategies:** 1. **Prioritization:** Prioritize tasks based on their importance and potential impact. 2. **Regular Check-ins:** Schedule regular check-ins with mentors to discuss progress and address any challenges. 3. **Online Resources:** Utilize online resources and tutorials to learn new skills and overcome technical hurdles. ## References / relevant background info I have experience in writing technical content like user guides, articles, blogs, and documentation on platforms like Geeks for Geeks and HashNode. **Geeks for Geeks Articles:** - [Article on NextJs Route Groups](https://www.geeksforgeeks.org/nextjs-route-groups-and-project-organization/?itm_source=auth&itm_medium=contributions&itm_campaign=articles) - [Article on GitHub Relative link in Markdown file](https://www.geeksforgeeks.org/github-relative-link-in-markdown-file/?itm_source=auth&itm_medium=contributions&itm_campaign=articles) - [Article on User Guide to change language in Gemini AI](https://www.geeksforgeeks.org/how-to-change-language-in-gemini-ai/?itm_source=auth&itm_medium=contributions&itm_campaign=articles) **HashNode Blogs:** [Link to hashnode](https://rupard.hashnode.dev/) I have a proven track record of contributing to high-quality technical documentation for open-source projects. You can find some examples of my contributions below: - **Restaurant Management Dashboard Technical Documentation:** Contributed to the technical documentation for a Restaurant Management Dashboard project. You can find the documentation here: [Link to Restaurant Management Dashboard Technical Documentation](https://github.com/Rupa-Rd/Restaurant-Management-Dashboard/blob/main/README.md). - **Technical Documentation Contribution to CSE Edge:** Made a contribution to the technical documentation on how to create a Rest API using Node, Express, MongoDB and deploy it. [Link to the contribution](https://github.com/CSEdgeOfficial/learn.csedge.courses/pull/298). - **Numpy Datatypes Documentation Contribution to Learn Python:** Contributed to the documentation on Numpy Datatypes including the types, functions, and examples for each. [Link to the contribution](https://github.com/animator/learn-python/pull/471). ## How to reach you **Element UserName:** @rupa_rd:matrix.org **Email:** roopa.69.spr@gmail.com Note: we don't need (yet) your personal address/phone, it will be necessary only if you succeed the SoK and wants to get goodies. <!-- Do not remove this line and the two below, else your proposal will become public and the team won't be notified of it --> /cc @teams/season-of-kde